Cloud

Build 26.0.9770
  • Garoon
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • AdminFacilities
        • AdminFacilityGroups
        • Discussions
        • Events
        • Messages
        • NotificationItems
        • SpaceFiles
        • ToDo
        • UserPresence
      • ビュー
        • BulletinCategories
        • BulletinCategoryTopics
        • BulletinTopics
        • BulletinTopicsDraft
        • DiscussionAttachments
        • EventAttachments
        • EventAttendees
        • EventFacilities
        • EventWatchers
        • Facilities
        • FacilityGroups
        • Files
        • MessageAttachments
        • MessageList
        • Organizations
        • OrganizationUsers
        • RequestItems
        • Requests
        • RequestSteps
        • SpaceAttachments
        • Spaces
        • ToDoCategories
        • Users
      • ストアドプロシージャ
        • AddDiscussionComment
        • DownloadFile
        • DownloadMessageAttachment
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • URL
        • User
        • Password
        • BasicAuthUser
        • BasicAuthPassword
      • SSL
        • SSLClientCert
        • SSLClientCertType
        • SSLClientCertPassword
        • SSLClientCertSubject
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • Pagesize
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
    • Third Party Copyrights

Garoon - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるGaroon へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してGaroon に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Garoon への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Garoon は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのGaroon への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Garoon への接続

接続の確立 は、CData Cloud にデータベースを作成するためのGaroon への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してGaroon からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Garoon に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Garoon への接続

認証値に加えて、下記のパラメータを使いGaroon に接続しデータを取得します。

  • URL:アカウントのURL。

NOTE:サポートされているバージョンで許容されるURL 形式は以下のとおりです。

  • Cloud 版:https://(subdomain).cybozu.com
  • Package 版(Windows 環境):http://(server IP address or host name)/scripts/(installation identifier)/grn.exe
  • Package 版(Linux 環境):http://(server IP address or host name)/cgi-bin/(installation identifier)/grn.cgi

Garoon への認証

Garoon は、以下の認証メソッドをサポートしています。

パスワード

Garoon への認証には、以下を設定する必要があります。

  • User:アカウントのユーザー名。
  • Password:アカウントのパスワード。
  • AuthScheme:AuthScheme をPassword に設定。

追加のセキュリティ

これまでに説明した認証スキームに加えて、Garoon はBasic 認証ヘッダーおよびSSL 証明書の形で追加のセキュリティを提供します。

Basic

Basic 認証を使用しているGaroon 環境では、追加のBasic 資格情報を渡す必要があります。そのためには、次を設定してください。

  • BasicAuthUser - Basic ログイン名。
  • BasicAuthPassword - Basic パスワード。

クライアントSSL

認証情報に加えて、リクエストの受け入れにSSL 証明書が必須となるようGaroon を設定することができます。そのためには、次を設定してください。

  • SSLClientCert - SSL 証明書の証明書を含むファイル。または、クライアント証明書のための証明書ストア名。
  • SSLClientCertType - 証明書の種類。
  • SSLClientCertSubject - (オプション)証明書ストアで証明書を検索する際に、ストア内でこのプロパティの値を含むサブジェクトを検索します。
  • SSLClientCertPassword - 証明書ストアでパスワードが必要とされる場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

Garoon Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

  • SSLClientCert:クライアント証明書のための証明書ストア名。
  • SSLClientCertType:TLS / SSL クライアント証明書を格納するキーストアの種類。
  • SSLClientCertPassword:TLS / SSL クライアント証明書のパスワード。
  • SSLClientCertSubject:TLS / SSL クライアント証明書のサブジェクト。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Garoon API へのSQL の実行について詳しく説明します。

主要機能

  • Cloud はドキュメント、フォルダ、およびグループなどのGaroon エンティティをリレーショナルビューとしてモデル化し、SQL を記述してGaroon データをクエリできるようにします。
  • ストアドプロシージャを使用するとGaroon の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Cloud を使用するとGaroon アカウントへのあらゆる変更が即座に反映されます。

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルは、Events、NotificationItems、UserPresence を静的にモデル化するように定義されています。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、EventAttendees、Users、およびRequests などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、Garoon のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Garoon の操作を実行できます。

CData Cloud

テーブル

Cloud はGaroon のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Garoon テーブル

Name Description
AdminFacilities Query, create, update, and delete facilities using administrator privileges.
AdminFacilityGroups Query, create, update, and delete facility groups using administrator privileges.
Discussions Query and create discussions in a space.
Events Query, create, modify, and delete regarding events.
Messages Query and create regarding messages.
NotificationItems Query, create, modify regarding notification items.
SpaceFiles Query and delete space attachment files. The Id column is required for querying.
ToDo Query and create to-do items.
UserPresence 在籍情報をクエリおよび変更します。

CData Cloud

AdminFacilities

Query, create, update, and delete facilities using administrator privileges.

Table-Specific Information

SELECT

Cloud はGaroon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id は '=,IN' 演算子をサポートします。
  • Name は '=' 演算子をサポートします。
  • NameLocaleJa は '=' 演算子をサポートします。
  • NameLocaleEn は '=' 演算子をサポートします。
  • NameLocaleZh は '=' 演算子をサポートします。
  • NameLocaleZhTw は '=' 演算子をサポートします。
  • Code は '=,IN' 演算子をサポートします。
  • Notes は '=' 演算子をサポートします。
  • FacilityGroupId は '=,IN' 演算子をサポートします。

例えば、次のクエリはサーバー側で処理され、その他のフィルタはCloud 内部でクライアント側で処理されます。

SELECT * FROM AdminFacilities WHERE Id = 7
SELECT * FROM AdminFacilities WHERE Id IN (1, 2, 3, 4)
SELECT * FROM AdminFacilities WHERE Name = 'Jeremiah'
SELECT * FROM AdminFacilities WHERE NameLocaleJa = '会議室A'
SELECT * FROM AdminFacilities WHERE NameLocaleEn = 'Meeting room A'
SELECT * FROM AdminFacilities WHERE NameLocaleZh = '会议室A'
SELECT * FROM AdminFacilities WHERE NameLocaleZhTw = '會議室A'
SELECT * FROM AdminFacilities WHERE Code = 'meeting_room_a'
SELECT * FROM AdminFacilities WHERE Code IN ('meeting_room_a', 'meeting_room_b')
SELECT * FROM AdminFacilities WHERE Notes = 'This is note'
SELECT * FROM AdminFacilities WHERE FacilityGroupId = 1
SELECT * FROM AdminFacilities WHERE FacilityGroupId IN (1, 2)

INSERT

Insert には Name と Code カラムが必須です:

INSERT INTO AdminFacilities(Name, NameLocaleEn, NameLocaleZh, Code, FacilityGroupId) VALUES('GaroonAdmin', 'US', 'RJ', 'GAdmin', 5)

UPDATE

AdminFacilities を更新するには、Id を指定する必要があります。ReadOnly がfalse のカラムを更新できます。

UPDATE AdminFacilities SET Name = 'Brian' WHERE Id = 10

DELETE

AdminFacilities を削除するには、Id を指定する必要があります。

DELETE FROM AdminFacilities WHERE Id = 9

Columns

Name Type ReadOnly Description
Id [KEY] Int True

Id of the facility.

Name String False

Name of the facility.

NameLocaleJa String False

Japanese display name of the facility.

NameLocaleEn String False

English display name of the facility.

NameLocaleZh String False

Simplified Chinese display name of the facility.

NameLocaleZhTw String False

Traditional Chinese display name of the facility.

Code String False

Code of the facility.

Notes String False

Notes of the facility.

FacilityGroupId Int False

Id of the facility group the facility belongs to.

CData Cloud

AdminFacilityGroups

Query, create, update, and delete facility groups using administrator privileges.

Table-Specific Information

SELECT

Cloud はGaroon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id は '=,IN' 演算子をサポートします。
  • Name は '=' 演算子をサポートします。
  • NameLocaleJa は '=' 演算子をサポートします。
  • NameLocaleEn は '=' 演算子をサポートします。
  • NameLocaleZh は '=' 演算子をサポートします。
  • NameLocaleZhTw は '=' 演算子をサポートします。
  • Code は '=,IN' 演算子をサポートします。
  • Notes は '=' 演算子をサポートします。
  • ParentFacilityGroupId は '=,IN' 演算子をサポートします。

例えば、次のクエリはサーバー側で処理され、その他のフィルタはCloud 内部でクライアント側で処理されます。

SELECT * FROM AdminFacilityGroups WHERE Id = 7
SELECT * FROM AdminFacilityGroups WHERE Id IN (1, 2, 3, 4)
SELECT * FROM AdminFacilityGroups WHERE Name = 'Benzamin'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleJa = '会議室A'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleEn = 'Meeting room A'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleZh = '会议室A'
SELECT * FROM AdminFacilityGroups WHERE NameLocaleZhTw = '會議室A'
SELECT * FROM AdminFacilityGroups WHERE Code = 'meeting_room_a'
SELECT * FROM AdminFacilityGroups WHERE Code IN ('meeting_room_a', 'meeting_room_b')
SELECT * FROM AdminFacilityGroups WHERE Notes = 'This is note'
SELECT * FROM AdminFacilityGroups WHERE ParentFacilityGroupId = 1
SELECT * FROM AdminFacilityGroups WHERE ParentFacilityGroupId IN (1, 2)

INSERT

Insert には Name と Code カラムが必須です:

INSERT INTO AdminFacilityGroups(Name, NameLocaleEn, NameLocaleZh, Code, ParentFacilityGroupId) VALUES('Benzamin', 'US', 'RJ', 'GAdmin', 1)

UPDATE

AdminFacilityGroups を更新するには、Id を指定する必要があります。ReadOnly がfalse のカラムを更新できます。

UPDATE AdminFacilityGroups SET Name = 'Brian' WHERE Id = 10

DELETE

AdminFacilityGroups を削除するには、Id を指定する必要があります。

DELETE FROM AdminFacilityGroups WHERE Id = 9

Columns

Name Type ReadOnly Description
Id [KEY] Int True

Id of the facility group.

Name String False

Name of the facility group.

NameLocaleJa String False

Japanese display name of the facility group.

NameLocaleEn String False

English display name of the facility group.

NameLocaleZh String False

Simplified Chinese display name of the facility group.

NameLocaleZhTw String False

Traditional Chinese display name of the facility group.

Code String False

Code of the facility group.

Notes String False

Notes of the facility group.

ParentFacilityGroupId Int False

Id of the parent facility group.

ChildFacilityGroups String True

Child facility groups of the facility group.

CData Cloud

Discussions

Query and create discussions in a space.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • SpaceId は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Discussions WHERE SpaceId = 3

Insert

Discussion を追加するには、SpaceId と Title フィールドを指定する必要があります。

INSERT INTO Discussions (SpaceId, Title) VALUES (3, 'New Discussion')

本文を含む Discussion:

INSERT INTO Discussions (SpaceId, Title, Body) VALUES (3, 'New Discussion', 'This is the body of the discussion.')

HTML 本文を含む Discussion:

INSERT INTO Discussions (SpaceId, Title, Body, IsHtmlBody) VALUES (3, 'HTML Discussion', 'This is HTML body', true)

Columns

Name Type ReadOnly Description
Id [KEY] String True

ID of the discussion.

SpaceId String False

ID of the space.

Title String False

Title of the discussion.

Body String False

Body of the discussion.

IsHtmlBody Boolean False

Whether body is HTML format.

CreatedAt Datetime True

Creation date and time.

CreatorId String True

Creator's Garoon user ID.

CreatorCode String True

Creator's login name.

CreatorName String True

Creator's display name.

UpdatedAt Datetime True

Update date and time.

UpdaterId String True

Updater's Garoon user ID.

UpdaterCode String True

Updater's login name.

UpdaterName String True

Updater's display name.

CData Cloud

Events

Query, create, modify, and delete regarding events.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • DateTime は<、<=、=、>= および > 演算子をサポートします。
  • TargetType は'=' 演算子をサポートします。
  • Target は'=' 演算子をサポートします。

NOTE: Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります(つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です)。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Events WHERE DateTime >= '2019-11-22 00:00:00.0'
SELECT * FROM Events WHERE DateTime > '2019-11-22 00:00:00.0'
SELECT * FROM Events WHERE targetType = 'user' AND target = '4'

Update

ReadOnly がfalse のカラムを更新できます。

UPDATE Events 
SET EventMenu = 'test', Subject = 'test', Notes = 'TEMPORARY', visibilityType = 'PRIVATE', useAttendanceCheck = false, CompanyInfoName = 'CompanyName', CompanyInfoZipCode = 'CompanyZipCode',
 CompanyInfoAddress = 'CompanyAddress', CompanyInfoRoute = 'CompanyRoute', CompanyInfoRouteTime = '2020', CompanyInfoRouteFare = '223', CompanyInfoPhone = '24342232342' , 
 StartDateTime = '2019-01-28T06:51:24Z', StartTimeZone = 'Asia/Tokyo', EndDateTime = '2019-01-28T06:51:24Z', EndTimeZone = 'Asia/Tokyo', isAllDay = true, isStartOnly = false, AdditionalItemsItemValue = 'test'
 WHERE Id = 35

テンポラリテーブルの使用:

INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User1', 'USER')
INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User2', 'USER')
INSERT INTO Watchers#TEMP (Code, Type) VALUES ('User3', 'USER')
UPDATE Events SET Watchers = 'Watchers#TEMP' WHERE Id = 35

集計の使用:

UPDATE Events SET Watchers = '[
    {
      "type": "USER",
      "code": "c000001"
    }
  ]', visibilityType = 'SET_PRIVATE_WATCHERS' WHERE Id = 35
UPDATE Events SET Attendees = '[
    {
      "type": "USER",
      "code": "c000001"
    }
  ]' WHERE Id = 35
  UPDATE Events SET facilities = '[
    {
      "code": "F001"
    }
  ]' WHERE Id = 35

Insert

Event を追加するには、次のカラムの組み合わせの少なくとも1つを指定する必要があります。
a) EventType、StartDateTime、StartTimeZone、EndDateTime、EndTimeZone およびFacilities カラム。
b) EventType、StartDateTime、StartTimeZone、EndDateTime、EndTimeZone およびAttendees カラム。
c) EventType、StartDateTime、StartTimeZone、IsStartOnly(true) およびFacilities カラム。
d) EventType、StartDateTime、StartTimeZone、IsStartOnly(true) およびAttendees カラム。

テンポラリテーブルの使用:

INSERT INTO EventAttendees#TEMP (Code, Type) VALUES ('User', 'USER')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, IsStartOnly, Attendees) VALUES ('REGULAR', '2020-09-27T14:00:00+09:00', 'Asia/Tokyo', true, 'EventAttendees#TEMP')

INSERT INTO EventFacilities#TEMP (Code) VALUES ('FacilityGroupsFacility1')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone, Facilities) VALUES ('REGULAR', '2020-09-17T14:00:00', 'Asia/Tokyo', '2020-09-17T15:00:00', 'Asia/Tokyo', 'EventFacilities#TEMP')

添付ファイル付きのイベントを挿入します。(添付ファイルのコンテンツにはBase64 エンコードが必要です。)

INSERT INTO EventAttendees#TEMP (Code, Type) VALUES ('Endri', 'USER')
INSERT INTO EventAttachments#TEMP (name, contentType, content) VALUES ('test1.txt', 'plain/text', 'dGVzdA==')
INSERT INTO EventAttachments#TEMP (name, contentType, content) VALUES ('test2.txt', 'plain/text', 'dGVrdrdr33zdA==')
INSERT INTO Events (EventType, StartDateTime, StartTimeZone, isStartOnly, Attendees, Attachments ) VALUES ('REGULAR', '2020-09-27T14:00:00+09:00', 'Asia/Tokyo', true, 'EventAttendees#TEMP', 'EventAttachments#TEMP')

集計の使用:

INSERT INTO Events (EventType, StartDateTime, StartTimeZone, EndDateTime, EndTimeZone, IsStartOnly, Facilities) VALUES ('REGULAR', '2020-09-27T14:00:00', 'Asia/Tokyo', '2020-09-27T15:00:00', 'Asia/Tokyo', false, '[
    {
      "code": "F001"
    }
  ]')

Delete

イベントのId を指定することでイベントを削除できます。

DELETE FROM Events WHERE Id = 34

Columns

Name Type ReadOnly Description
Id [KEY] String True

Composed id of the event.

EventId Int True

Id of the event.

CreatorId Int True

Id of the creator.

CreatorCode String True

Code of the creator.

CreatorName String True

Name of the creator.

CreatedAt Datetime True

Created time.

UpdaterId Int True

Id of the updater.

UpdaterCode String True

Code of the updater.

UpdaterName String True

Name of the updater.

UpdatedAt Datetime True

Updated time.

EventType String False

Type of the event.

EventMenu String False

Menu of the event.

Subject String False

Subject of the event.

Notes String False

Notes of the event.

VisibilityType String False

Type of visibility.

UseAttendanceCheck Boolean False

Use attendance check.

Attachments String False

Attachments of the event.

Attendees String False

Attendees of the event.

AttendeesCandidate String True

Attendees candidate of the event.

CompanyInfoName String False

Name of company.

CompanyInfoZipCode String False

Zip code of company.

CompanyInfoAddress String False

Address of company.

CompanyInfoRoute String False

Route of company.

CompanyInfoRouteTime String False

Route time of company.

CompanyInfoRouteFare String False

Route fare of company.

CompanyInfoPhone String False

Phone number of company.

StartDateTime Datetime False

Time when event started.

StartTimeZone String False

Starting time zone.

EndDateTime Datetime False

Time when event ends.

EndTimeZone String False

Ending time zone.

IsAllDay Boolean False

When set to true, event is all day.

IsStartOnly Boolean False

When set to true,event is start only.

OriginalStartTimeZone String True

Original start time zone.

OriginalEndTimeZone String True

Original end time zone.

Watchers String False

Watchers of the event.

WatchersCandidate String True

Watchers candidate of the event.

Facilities String False

Facilities of the event.

FacilitiesCandidate String True

Facilities candidate of the event.

FacilityUsingPurpose String False

Facility using purpose

FacilityReservationInfo String True

Facility reservation info.

FacilityUsageRequests String True

Facility usage requests.

RepeatInfo String True

Repeat info.

TemporaryEventCandidates String True

Temporary event candidates.

RepeatId String True

Repeat id.

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
DateTime Datetime

Specify the date and time of the search target in RFC3339 format. Supported operators are =,<,>,<=,>=.

TargetType String

Specify the type to narrow down the results by user, organization or facility.

使用できる値は次のとおりです。user, organization, facility

Target String

Specify the ID to narrow down the results by user Id, organization Id or facility Id.

CData Cloud

Messages

Query and create regarding messages.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • Id は'=' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM Messages WHERE Id = 3

Insert

Message を追加するには、Title と Recipients フィールドを指定する必要があります。Title の最大文字数は 100 文字です。

基本的なメッセージの作成:

INSERT INTO Messages (Title, Recipients) VALUES ('This is title of updated message', '[{"id":1,"type":"USER"}]')

本文を含むメッセージ:

INSERT INTO Messages (Title, Recipients, Body, Acknowledgement, IsDraft)
VALUES ('This is title of message', '[{"id":1,"type":"USER"}]', 'This is body of the message.', true, false)

HTML 本文と操作権限を含むメッセージ:

INSERT INTO Messages (Title, Recipients, Body, IsHtmlBody, OperatorType, Operators)
VALUES ('HTML Message', '[{"id":1,"type":"USER"}]', 'This is HTML body', true, 'SELECT_USERS', '[{"id":2,"type":"USER"}]')

下書きメッセージの作成:

INSERT INTO Messages (Title, Recipients, Body, IsDraft)
VALUES ('Draft Message', '[{"id":1,"type":"USER"}]', 'Draft content', true)

Columns

Name Type ReadOnly Description
Id [KEY] String True

Message ID.

Title String False

Message title.

CreatorId String True

Creator's Garoon user ID.

CreatorCode String True

Creator's login name.

CreatorName String True

Creator's display name.

CreatedAt Datetime True

Creation date and time.

UpdaterId String True

Updater's Garoon user ID.

UpdaterCode String True

Updater's login name.

UpdaterName String True

Updater's display name.

UpdatedAt Datetime True

Update date and time.

Acknowledgement Boolean False

Whether to check reading status.

IsDraft Boolean False

Whether message is draft.

Body String False

Message body.

IsHtmlBody Boolean False

Whether body is HTML format.

OperatorType String False

Change/delete permission type.

Recipients String False

Message recipients.

Folders String True

Message folders.

Operators String False

Users allowed to change/delete message.

CData Cloud

NotificationItems

Query, create, modify regarding notification items.

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Upsert

NotificationItem を追加/更新するには、少なくともNotificationKey、Operation、Url、Title、App およびDestinations(Code、Type およびId)カラムを指定する必要があります。
Note:アプリでは、値に外部通知コードを指定する必要があります。
クエリで既存のNotificationKey が指定されている場合、API は既存のレコードを更新します。指定されていない場合は、新しいレコードが作成されます。

テンポラリテーブルの使用:

INSERT INTO Destinations#TEMP (Code, Type, id) VALUES ('cybozu', 'USER', 2)
UPSERT INTO NotificationItems (NotificationKey, Operation, Url, Title, App, Destinations) VALUES ('15', 'remove', 'https://developer.cybozu.io/hc/ja/articles/360026939911', 'Sample title', 'Concur', 'Destinations#TEMP')

集計の使用:

UPSERT INTO NotificationItems (NotificationKey, Operation, Url, Title, App, Destinations) VALUES ('15', 'remove', 'https://developer.cybozu.io/hc/ja/articles/360026939911', 'Sample title', 'Concur', '[
    {
      "type": "USER",
      "code": "userCode",
      "id": "1"
    }
  ]')

Columns

Name Type ReadOnly Description
NotificationKey [KEY] String False

Garoon notification key.

ModuleId [KEY] String True

Garoon module ID.

CreatorId Int True

Garoon user ID of the creator of the notification.

CreatorCode String True

Garoon user name of the creator of the notification.

CreatorName String True

Garoon user login name of the creator of the notification.

CreatedAt Datetime True

Notification creation date and time.

Operation String False

Summary of notification operations.You can specify one of the following three values:add,modify,remove.

Url String False

URL included in the notification.

Title String False

Notification title.

Body String False

Notification text.

Icon String False

Notification icon. A sample icon or URI can be specified.

IsRead Boolean True

Whether the notification has been read.

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
Destinations String

List of notification destinations. This column is used for insert and does not return data.

App String

Specify the external notification code set in Garoon's application management.

CData Cloud

SpaceFiles

Query and delete space attachment files. The Id column is required for querying.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM SpaceFiles WHERE Id = 3

Delete

ファイルのId を指定することでスペース添付ファイルを削除できます。

DELETE FROM SpaceFiles WHERE Id = 3

Columns

Name Type ReadOnly Description
Id [KEY] String True

ID of the attachment file.

ContentType String True

MIME type of the file.

Name String True

Name of the file.

Size Long True

Size of the file in bytes.

Content String True

Base64-encoded content of the file.

CData Cloud

ToDo

Query and create to-do items.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ToDo WHERE Id = 3

Insert

ToDo 項目を追加するには、Subject フィールドを指定する必要があります。

INSERT INTO ToDo (Subject) VALUES ('New task')

カテゴリ、期限日、優先度、メモを含む ToDo:

INSERT INTO ToDo (Subject, CategoryId, DueDate, Priority, Notes) VALUES ('New task', 1, '2026-12-31T17:00:00Z', 2, 'Follow up before EOY')

Columns

Name Type ReadOnly Description
Id [KEY] Int True

ID of the to-do item.

Status String True

Status of the to-do. One of: Completed, Uncompleted.

CategoryId Int False

ID of the category.

Subject String False

Subject of the to-do item.

HasDueDate Boolean True

Whether a due date is set.

DueDate Datetime False

Due date of the to-do item.

Priority Int False

Priority of the to-do item. One of: 1, 2, 3.

Notes String False

Notes for the to-do item.

CData Cloud

UserPresence

在籍情報をクエリおよび変更します。

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id = 演算子をサポートします。
  • コード = 演算子をサポートします。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM UserPresence WHERE Id = 24 
SELECT * FROM UserPresence WHERE Code = 'admin'

Update

ReadOnly がfalse のカラムを更新できます。

UPDATE UserPresence SET StatusCode = 'attend', Notes = 'Sample note' WHERE Id = 2

Columns

Name Type ReadOnly Description
Id [KEY] Int True

Garoon ユーザー ID。

Name String True

Garoon ユーザーの表示名。

Code String True

Garoon ユーザーのログイン名。

UpdatedAt Datetime True

在籍情報の更新日時。形式はISO8601 UTC タイムゾーンです。

Notes String False

メモ。

StatusCode String False

在籍情報のステータスコード。

StatusName String True

在籍情報のステータス名。

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Garoon ビュー

Name Description
BulletinCategories Query bulletin board categories.
BulletinCategoryTopics Query bulletin board topics within a category.
BulletinTopics Query bulletin board topics by ID. The Id column is required for querying.
BulletinTopicsDraft Query bulletin board draft topics by ID. The Id column is required for querying.
DiscussionAttachments Query a list of attachments for a discussion.
EventAttachments 予定の添付ファイルに関する情報をクエリします。
EventAttendees 予定の参加者に関する情報をクエリします。
EventFacilities 予定の施設に関する情報をクエリします。
EventWatchers 予定の公開先に関する情報をクエリします。
Facilities 施設に関する情報をクエリします。
FacilityGroups 施設グループに関する情報をクエリします。
Files 申請のファイルに関する情報をクエリします。
MessageAttachments Query information regarding message attachments.
MessageList Query information regarding messages with admin privileges.
Organizations 組織に関する情報をクエリします。
OrganizationUsers 組織に所属するユーザーに関する情報をクエリします。
RequestItems 申請項目に関する情報をクエリします。
Requests 申請に関する情報をクエリします。
RequestSteps 申請ステップに関する情報をクエリします。
SpaceAttachments Query a list of attachments for a space.
Spaces Query information regarding spaces.
ToDoCategories Query to-do categories.
Users Query information regarding users.

CData Cloud

BulletinCategories

Query bulletin board categories.

Select

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name Type Description
Id [KEY] String ID of the bulletin category.
Name String Name of the bulletin category.
Description String Description of the bulletin category.
HasSubCategories Boolean Whether the category has sub-categories.

CData Cloud

BulletinCategoryTopics

Query bulletin board topics within a category.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • CategoryId は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM BulletinCategoryTopics WHERE CategoryId = 1

Columns

Name Type Description
Id [KEY] String ID of the bulletin topic.
CategoryId [KEY] String ID of the bulletin category to retrieve topics for.
Subject String Subject of the bulletin topic.
UpdatedAt Datetime Update date and time.
UpdaterId String Updater's Garoon user ID.
UpdaterCode String Updater's login name.
UpdaterName String Updater's display name.
ManuallySender String Manually entered sender name.

CData Cloud

BulletinTopics

Query bulletin board topics by ID. The Id column is required for querying.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM BulletinTopics WHERE Id = 3

Columns

Name Type Description
Id [KEY] String ID of the bulletin topic.
Subject String Subject of the bulletin topic.
CategoryId String ID of the category.
CategoryName String Name of the category.
PublicPeriodIsUnlimited Boolean Whether the public period is unlimited.
PublicPeriodStart Datetime Start of the public period.
PublicPeriodEnd Datetime End of the public period.
CreatedAt Datetime Creation date and time.
CreatorId String Creator's Garoon user ID.
CreatorCode String Creator's login name.
CreatorName String Creator's display name.
UpdatedAt Datetime Update date and time.
UpdaterId String Updater's Garoon user ID.
UpdaterCode String Updater's login name.
UpdaterName String Updater's display name.
Body String Body of the bulletin topic.
IsHtmlBody Boolean Whether the body is HTML format.
AllowComments Boolean Whether comments are allowed.
OperatorType String Change or delete permission type.
Operators String Users or groups with change or delete permission.
Acknowledgement Boolean Whether reading acknowledgement is required.
Attachments String Files attached to the bulletin topic.
IsDraft Boolean Whether the topic is a draft.
IsPublished Boolean Whether the topic has been published.
IsExpired Boolean Whether the public period of the topic has expired.

CData Cloud

BulletinTopicsDraft

Query bulletin board draft topics by ID. The Id column is required for querying.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM BulletinTopicsDraft WHERE Id = 3

Columns

Name Type Description
Id [KEY] String ID of the draft topic.
Subject String Subject of the draft topic.
CategoryId String ID of the category.
CategoryName String Name of the category.
PublicPeriodIsUnlimited Boolean Whether the public period is unlimited.
PublicPeriodStart Datetime Start of the public period.
PublicPeriodEnd Datetime End of the public period.
CreatedAt Datetime Creation date and time.
CreatorId String Creator's Garoon user ID.
CreatorCode String Creator's login name.
CreatorName String Creator's display name.
UpdatedAt Datetime Update date and time.
UpdaterId String Updater's Garoon user ID.
UpdaterCode String Updater's login name.
UpdaterName String Updater's display name.
ManuallySender String Manually entered sender name.
Body String Body of the draft topic.
IsHtmlBody Boolean Whether the body is HTML format.
AllowComments Boolean Whether comments are allowed.
OperatorType String Change or delete permission type.
Operators String Users or groups with change or delete permission.
Acknowledgement Boolean Whether reading acknowledgement is required.
Attachments String Files attached to the draft topic.
IsDraft Boolean Whether the topic is a draft.
IsPublished Boolean Whether the topic has been published.
IsExpired Boolean Whether the public period of the topic has expired.

CData Cloud

DiscussionAttachments

Query a list of attachments for a discussion.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • DiscussionId は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM DiscussionAttachments WHERE DiscussionId = 3

Columns

Name Type Description
Id [KEY] String ID of the file.
DiscussionId String ID of the discussion to retrieve attachments for.
Name String Name of the file.
Size Long Size of the file in bytes.
CreatedAt Datetime Creation date and time.
UpdatedAt Datetime Update date and time.
CreatorId String Creator's Garoon user ID.
CreatorCode String Creator's login name.
CreatorName String Creator's display name.
UpdaterId String Updater's Garoon user ID.
UpdaterCode String Updater's login name.
UpdaterName String Updater's display name.

CData Cloud

EventAttachments

予定の添付ファイルに関する情報をクエリします。

ビュー固有の情報

Cloud はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TargetType は'=' 演算子をサポートします。
  • Target は'=' 演算子をサポートします。

NOTE: Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります(つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です)。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventAttachments WHERE TargetType = 'user' AND Target = '4'

Columns

Name Type Description
EventId [KEY] Int 予定ID。
EventStartDateTime [KEY] Datetime 予定の開始日時。
EventEndDateTime [KEY] Datetime 予定の終了日時。
AttachmentId [KEY] Int 添付ファイルID。
Name String 添付ファイル名。
Size Int 添付ファイルのサイズ。
ContentType String 添付ファイルのコンテンツタイプ。

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
TargetType String ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。

使用できる値は次のとおりです。user, organization, facility

Target String ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

CData Cloud

EventAttendees

予定の参加者に関する情報をクエリします。

ビュー固有の情報

Cloud はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TargetType は'=' 演算子をサポートします。
  • Target は'=' 演算子をサポートします。

NOTE: Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります(つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です)。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventAttendees WHERE TargetType = 'organization' AND Target = '4'

Columns

Name Type Description
EventId [KEY] Int 予定ID。
EventStartDateTime [KEY] Datetime 予定の開始日時。
EventEndDateTime [KEY] Datetime 予定の終了日時。
AttendeeId [KEY] Int 参加者のユーザーID。
Name String 参加者の表示名。
Code String 参加者コード。
Type String 参加者のタイプ。

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
TargetType String ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。

使用できる値は次のとおりです。user, organization, facility

Target String ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

CData Cloud

EventFacilities

予定の施設に関する情報をクエリします。

ビュー固有の情報

Cloud はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TargetType は'=' 演算子をサポートします。
  • Target は'=' 演算子をサポートします。

NOTE: Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります(つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です)。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventFacilities WHERE TargetType = 'facility' AND Target = '4'

Columns

Name Type Description
EventId [KEY] Int 予定ID。
EventStartDateTime [KEY] Datetime 予定の開始日時。
EventEndDateTime [KEY] Datetime 予定の終了日時。
FacilityId [KEY] Int 施設ID。
Name String 施設名。
Code String 施設コード。
Notes String 施設のメモ。

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
TargetType String ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。

使用できる値は次のとおりです。user, organization, facility

Target String ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

CData Cloud

EventWatchers

予定の公開先に関する情報をクエリします。

ビュー固有の情報

Cloud はGaroon API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • TargetType は'=' 演算子をサポートします。
  • Target は'=' 演算子をサポートします。

NOTE: Target フィールドとTargetType フィールドは、クエリで両方使用する必要があります(つまり、Target フィールドがクエリで指定されている場合、TargetType フィールドも必須であり、その逆も同様です)。 例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM EventWatchers WHERE TargetType = 'user' AND Target = '4'

Columns

Name Type Description
EventId [KEY] Int 予定ID。
EventStartDateTime [KEY] Datetime 予定の開始日時。
EventEndDateTime [KEY] Datetime 予定の終了日時。
WatcherId [KEY] Int 公開先のユーザーID。
Name String 公開先の表示名。
Code String 公開先のコード。
Type String 公開先のタイプ。

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
TargetType String ユーザー、組織、施設で結果を絞り込むには、タイプを指定します。

使用できる値は次のとおりです。user, organization, facility

Target String ユーザーID、組織ID、施設ID で結果を絞り込むにはID を指定します。

CData Cloud

Facilities

施設に関する情報をクエリします。

Select

Cloud はGaroon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id ORDER BY 演算子をサポートします。
  • FacilityGroupId = 演算子をサポートします。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Facilities ORDER BY id
SELECT Code FROM Facilities
SELECT Id, Subject FROM Events ORDER BY startDateTime DESC LIMIT 2
SELECT * FROM Facilities WHERE FacilityGroupId = 1

Columns

Name Type Description
Id [KEY] Int 施設ID。
Name String 施設名。
Code String 施設コード。
Notes String 施設のメモ。
FacilityGroupId Int 施設グループ。

CData Cloud

FacilityGroups

施設グループに関する情報をクエリします。

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name Type Description
Id [KEY] Int 施設グループID。
Name String 施設グループ名。
Code String 施設グループコード。
Notes String 施設グループのメモ。
ParentFacilityGroupId Int 親施設グループID。
ChildFacilityGroups String 子施設グループID。

CData Cloud

Files

申請のファイルに関する情報をクエリします。

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • Id = 演算子をサポートします。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Files WHERE Id = 1

Columns

Name Type Description
Id [KEY] Int ファイルID。
Name String ファイル名。
ContentType String ファイルのコンテンツタイプ。
Size Int ファイルのサイズ。

CData Cloud

MessageAttachments

Query information regarding message attachments.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • MessageId は'=' 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM MessageAttachments WHERE MessageId = 3

Columns

Name Type Description
MessageId [KEY] String Message ID to retrieve attachments for.
Id [KEY] String ID of the file.
Name String Name of the file.
Size String Size of the file.
CreatorId String Creator's Garoon user ID.
CreatorName String Creator's display name.
CreatorCode String Creator's login name.
UpdaterId String Updater's Garoon user ID.
UpdaterName String Updater's display name.
UpdaterCode String Updater's login name.
CreatedAt Datetime Creation date and time.
UpdatedAt Datetime Update date and time.

CData Cloud

MessageList

Query information regarding messages with admin privileges.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでCloud 内部で処理されます。

  • UpdatedAt は <、<=、=、>= および > 演算子をサポートします。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM MessageList WHERE UpdatedAt >= '2026-02-16 00:00:00.0'
SELECT * FROM MessageList WHERE UpdatedAt = '2026-02-25 05:53:23.0'
SELECT * FROM MessageList WHERE UpdatedAt BETWEEN '2026-02-24 00:00:00.0' AND '2026-02-25 23:59:59.0'
SELECT * FROM MessageList WHERE UpdatedAt > '2026-02-12 01:10:03.0'

Columns

Name Type Description
Id [KEY] String Message ID.
Subject String Message title.
CreatorId String Creator's Garoon user ID.
CreatorName String Creator's display name.
CreatorCode String Creator's login name.
UpdaterId String Updater's Garoon user ID.
UpdaterName String Updater's display name.
UpdaterCode String Updater's login name.
CreatedAt Datetime Creation date and time.
UpdatedAt Datetime Update date and time.

CData Cloud

Organizations

組織に関する情報をクエリします。

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name Type Description
Id [KEY] Int 組織ID。
Name String 組織名。
Code String 組織コード。
ParentOrganization Int 親組織ID。
ChildOrganizations String 子組織ID。

CData Cloud

OrganizationUsers

組織に所属するユーザーに関する情報をクエリします。

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • OrganizationId = 演算子をサポートします。
例えば、次のクエリはサーバー側で処理されます。
SELECT OrganizationId, UserId FROM OrganizationUsers WHERE OrganizationId = 24 

Columns

Name Type Description
OrganizationId Int Garoon 組織ID。
UserId [KEY] Int Garoon ユーザーID。
Name String Garoon ユーザーの表示名。
Code String Garoon ユーザーのログイン名。

CData Cloud

RequestItems

申請項目に関する情報をクエリします。

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • FormId = 演算子をサポートします。
  • StatusType = および IN 演算子をサポートします。
  • ApprovedAt <、<=、=、>= および > 演算子をサポートします。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM RequestItems WHERE FormId = 3
SELECT * FROM RequestItems WHERE StatusType = 'REJECTED'
SELECT * FROM RequestItems WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestItems WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestItems WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name Type Description
RequestId [KEY] Int 申請ID。
FormId Int 申請フォームID。
StatusType String 申請のステータス。
ItemId [KEY] String 項目ID。
ItemName String 項目名。
Type String 項目のタイプ。
Value String 項目の値。
Single_Line_Text_Value String 項目の単一行テキスト値。
Multi_Line_Text_Value String 項目の複数行テキスト値。
Number_Value Decimal 項目の数値。
Calc_Value Decimal 項目の計算値。
Date_Value String 項目の日付の値。
DATETIME_Value String 項目の日時の値。
Radio_Button_Value String 項目のラジオボタン。
Drop_Down_Value String 項目のドロップダウンの値。
Check_Box_Value String 項目のチェックボックスの値。
Route_Navi_Value String 項目の路線ナビ連携の値。

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
ApprovedAt Datetime 最終承認日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。

CData Cloud

Requests

申請に関する情報をクエリします。

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • FormId = 演算子をサポートします。
  • StatusType = および IN 演算子をサポートします。
  • ApprovedAt <、<=、=、>= および > 演算子をサポートします。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Requests WHERE FormId = 3
SELECT * FROM Requests WHERE StatusType = 'REJECTED'
SELECT * FROM Requests WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM Requests WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM Requests WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name Type Description
Id [KEY] Int 申請ID。
StatusName String 申請のステータス名。
StatusType String ステータスのタイプ。
CreatedAt Datetime 申請の作成日時。形式はISO8601 UTC タイムゾーンです。
UpdatedAt Datetime 申請の更新日時。形式はISO8601 UTC タイムゾーンです。
ProcessingStepCode String 経路ステップのステップコード。
Name String 申請フォーム名。
Number String 申請番号。
IsUrgent Boolean 優先度が指定されているかどうか。
ApplicantId Int 申請者ID。
ApplicantCode String 申請者コード。
ApplicantName String 申請者のプロキシID。
ApplicantProxyId Int 申請者のプロキシコード。
ApplicantProxyCode String 申請者のプロキシ名。
ApplicantProxyName String 申請者の表示名。
FormId Int 申請フォームID。
FormName String 申請フォームの表示名。

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
ApprovedAt Datetime 最終承認日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。

CData Cloud

RequestSteps

申請ステップに関する情報をクエリします。

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • FormId = 演算子をサポートします。
  • StatusType = および IN 演算子をサポートします。
  • ApprovedAt <、<=、=、>= および > 演算子をサポートします。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM RequestSteps WHERE FormId = 3
SELECT * FROM RequestSteps WHERE StatusType = 'REJECTED'
SELECT * FROM RequestSteps WHERE StatusType IN ('REJECTED', 'UNPROCESSING')
SELECT * FROM RequestSteps WHERE ApprovedAt = '2017-09-01 06:32:57.0'
SELECT * FROM RequestSteps WHERE ApprovedAt >= '2017-09-01 06:32:57.0'

Columns

Name Type Description
RequestId Int 申請ID。
FormId Int 申請フォームID。
StatusType String 申請のステータス。
StepId [KEY] Int ステップのId。
StepName String ステップ名。
IsApprovalStep Boolean 承認ステップかどうか。
Requirement String ステップのタイプ。

Pseudocolumns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるデータを詳細に制御することができます。

Name Type Description
ApprovedAt Datetime 最終承認日時をRFC3339 形式で指定します。サポートされる演算子は =、<、>、<=、>= です。

CData Cloud

SpaceAttachments

Query a list of attachments for a space.

Select

Cloud は Garoon API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でCloud 内部で処理されます。

  • SpaceId は '=' 演算子をサポートし、クエリの実行に必須です。

例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM SpaceAttachments WHERE SpaceId = 3

Columns

Name Type Description
Id [KEY] String ID of the file.
SpaceId String ID of the space to retrieve attachments for.
Name String Name of the file.
Size Long Size of the file in bytes.
CreatedAt Datetime Creation date and time.
UpdatedAt Datetime Update date and time.
CreatorId String Creator's Garoon user ID.
CreatorCode String Creator's login name.
CreatorName String Creator's display name.
UpdaterId String Updater's Garoon user ID.
UpdaterCode String Updater's login name.
UpdaterName String Updater's display name.

CData Cloud

Spaces

Query information regarding spaces.

Select

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name Type Description
Id [KEY] String ID of the space.
Name String Name of the space.
IsPublic Boolean Whether the space is public.
CategoryId String ID of the category.
CategoryName String Name of the category.
CreatedAt Datetime Creation date and time.
CreatorId String Creator's Garoon user ID.
CreatorCode String Creator's login name.
CreatorName String Creator's display name.
UpdatedAt Datetime Update date and time.
UpdaterId String Updater's Garoon user ID.
UpdaterCode String Updater's login name.
UpdaterName String Updater's display name.

CData Cloud

ToDoCategories

Query to-do categories.

Select

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name Type Description
Id [KEY] Int ID of the to-do category.
Name String Name of the to-do category.

CData Cloud

Users

Query information regarding users.

ビュー固有の情報

Garoon は、このビューをフィルタリングするためのカラムをサポートしていません。すべてのフィルタはクライアント側で実行されます。

Columns

Name Type Description
Id [KEY] Int Id of the user.
Name String Name of the user.
Code String Code of the user.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Garoon の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGaroon から関連するレスポンスデータを返します。

CData Cloud - Garoon ストアドプロシージャ

Name Description
AddDiscussionComment Add a comment to a discussion in a space.
DownloadFile 申請で指定されたファイルをダウンロードします。
DownloadMessageAttachment Download a message attachment file.

CData Cloud

AddDiscussionComment

Add a comment to a discussion in a space.

Input

Name Type Required Description
SpaceId String True ID of the space containing the discussion.
DiscussionId String True ID of the discussion to add the comment to.
Body String True Body of the comment.
IsHtmlBody Boolean False Whether the body is HTML format.

Result Set Columns

Name Type Description
Status String The status of the operation.
Id String The unique identifier of the sheet created.

CData Cloud

DownloadFile

申請で指定されたファイルをダウンロードします。

Input

Name Type Required Description
FileId String True ファイルのId。
DownloadLocation String False ダウンロードしたファイルの場所。Ex- C:\Temp\CompanyFiles
Encoding String False FileData のインプットエンコーディングタイプ。

使用㝧㝝る値㝯次㝮㝨㝊り㝧㝙。NONE, BASE64

デフォルト値㝯BASE64㝧㝙。

Result Set Columns

Name Type Description
Success String ダウンロードが成功した場合はTrue を返します。
FileData String DownloadLocation とFileStream が指定されない場合、ファイルの内容が含まれます。

CData Cloud

DownloadMessageAttachment

Download a message attachment file.

Input

Name Type Required Description
FileId String False File Id to download.
MessageId String False Message Id to download all the attachments in the Message.
DownloadLocation String False Download location. This is required when MessageId is specified.
Encoding String False The FileData input encoding type.

使用㝧㝝る値㝯次㝮㝨㝊り㝧㝙。NONE, BASE64

デフォルト値㝯BASE64㝧㝙。

Result Set Columns

Name Type Description
Status String The status of the operation.
FileData String If the DownloadLocation and FileStream are not provided, this contains the content of the file.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Garoon のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。
IsInsertable Boolean テーブルに挿入可能かどうか。
IsDeleteable Boolean テーブルから行を削除可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Events テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'Events' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。
ColumnCapabilities Int32 カラムの書き込み機能を示すビットマスク。値は次の合計です:1 はINSERT 時にカラムが必須であることを示し、2 はINSERT 時にカラムが許可されていることを示し、4 はUPDATE 時にカラムが許可されていることを示します。値が0 の場合、カラムの書き込み機能が不明であるか、カラムが読み取り専用であることを示します。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのGaroon プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudocolumns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Events テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Events' 
          

Columns

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 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         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 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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 プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。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_BYGROUP 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_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加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_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
URLGaroon アカウントのURL。
User認証するユーザーのユーザーID を指定します。
Password認証するユーザーのパスワードを指定します。
BasicAuthUserBasic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPasswordBasic 認証を使用するドメインに必要な追加のパスワード。

SSL


プロパティ説明
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertTypeSSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPasswordTLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemas利用可能なすべてのスキーマのサブセットに報告されるスキーマを制限するオプション設定。例: BrowsableSchemas=SchemaA,SchemaB,SchemaC 。

Miscellaneous


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Pagesizeprovider がGaroon にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
URLGaroon アカウントのURL。
User認証するユーザーのユーザーID を指定します。
Password認証するユーザーのパスワードを指定します。
BasicAuthUserBasic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPasswordBasic 認証を使用するドメインに必要な追加のパスワード。
CData Cloud

URL

Garoon アカウントのURL。

データ型

string

デフォルト値

""

解説

'https://cyp344.cybozu.com' 形式のGaroon アカウントのURL。

CData Cloud

User

認証するユーザーのユーザーID を指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのIDを検証するためにUserとPasswordの両方を必要とします。

CData Cloud

Password

認証するユーザーのパスワードを指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのIDを検証するためにUserとPasswordの両方を必要とします。

CData Cloud

BasicAuthUser

Basic 認証を使用するドメインに必要な追加のユーザー名。

データ型

string

デフォルト値

""

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のユーザー名。このフィールドは、BasicAuthPassword とともに、Garoon サーバーへのユーザー認証を実現するために使用されます。

CData Cloud

BasicAuthPassword

Basic 認証を使用するドメインに必要な追加のパスワード。

データ型

string

デフォルト値

""

解説

Basic 認証が有効なドメインに接続するために使用するBasic 認証のパスワード。このフィールドは、BasicAuthUser とともに、Garoon サーバーへのユーザー認証を実現するために使用されます。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertTypeSSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPasswordTLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLClientCert

SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

データ型

string

デフォルト値

""

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY(個人証明書)などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA証明機関の証明書。
ROOTルート証明書。
SPCソフトウェア発行元証明書。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

CData Cloud

SSLClientCertType

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルトWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILEこの証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOBこの証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。

CData Cloud

SSLClientCertPassword

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

データ型

string

デフォルト値

""

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合(Windows のUSER やMACHINE など)、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

CData Cloud

SSLClientCertSubject

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

データ型

string

デフォルト値

"*"

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Cloud は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Cloud はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

Note: フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例:CN="Example, Inc.", C=US。

CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemas利用可能なすべてのスキーマのサブセットに報告されるスキーマを制限するオプション設定。例: BrowsableSchemas=SchemaA,SchemaB,SchemaC 。
CData Cloud

BrowsableSchemas

利用可能なすべてのスキーマのサブセットに報告されるスキーマを制限するオプション設定。例: BrowsableSchemas=SchemaA,SchemaB,SchemaC 。

データ型

string

デフォルト値

""

解説

利用可能なすべてのデータベーススキーマの一覧表示には余分な時間がかかり、パフォーマンスが低下する場合があります。接続文字列にスキーマのリストを提供することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Pagesizeprovider がGaroon にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

Pagesize

provider がGaroon にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

1000

解説

クエリを処理する際、Garoon でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

ThrowsKeyNotFound

更新された行がない場合に例外をスローするかどうかを指定します。

データ型

bool

デフォルト値

false

解説

更新された行がない場合に例外をスローするかどうかを指定します。

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770