CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるTrello へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してTrello に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Trello への接続を標準化し、構成することができます。
このページでは、CData Cloud でのTrello への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのTrello への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してTrello からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Trello に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Trello API は、Trello 自身の認可ルート、またはOAuth 経由でアクセスできます。
登録の時点で、Trello はAPI キーとトークンをアカウントに割り当てます。
認可ルート経由のアクセスを有効にするには:
API キーとトークンの両方が取得できたら、Trello APIへのリクエストの準備は完了です。
以下のサブセクションでは、3つの一般的な認証フローでのTrello への認証について詳しく説明します。
カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。
Trello で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
OAuth アクセストークンの自動リフレッシュ:
Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
OAuth によるTrello への認証には、カスタムOAuth アプリケーションの作成と登録が必要です。これにより、アカウントのOAuthClientId を取得できるようになります。
以下の手順に従います。
Trello のOrganizationId は、接続文字列で指定することで特定のTrello 組織を参照します。指定すると、いくつかのクエリの対象範囲がその組織に関連付けられます。例:
SELECT * FROM Listsは、その組織のボードのリストをすべて返します。
SELECT * FROM Membershipsは、その組織のメンバーをすべて返します。
SELECT * FROM Actionsは、その組織のアクションをすべて返します。
Trello のBoardId は、接続文字列で指定することで、特定のTrello ボードを参照します。指定すると、いくつかのクエリの対象範囲がそのボードに関連付けられます。例:
SELECT * FROM Listsは、そのボードのリストをすべて返します。
SELECT * FROM Membershipsは、そのボードのメンバーをすべて返します。
SELECT * FROM Actionsは、そのボードのすべてのアクションを返します。ボードは多数のアクションを持つ可能性があるため、クエリの実行に時間がかかる場合があります。
Trello のMemberId は、接続文字列で指定することで、特定のTrello メンバーを参照します。指定すると、いくつかのクエリの対象範囲がそのメンバーに関連付けられます。例:
SELECT * FROM Actionsは、そのメンバーのアクションをすべて返します。
SELECT * FROM Boardsは、ログインしているユーザー、および指定されたメンバーの両方が共通して持つボードをすべて返します。
カスタムフィールドはTrello で最も人気のあるPower-Up です。カスタムフィールドを使い始めるには、Trello ボードでPower-Up を有効にして、カードにカスタムフィールドを作成、または追加します。
IncludeCustomFields はすでにデフォルトでtrue に設定されているので、接続文字列にBoardId を指定するだけでカスタムフィールドが表示されるようになります。この接続プロパティは、Trello カードに作成されたカスタムフィールドを取得するために使用します。
SELECT * FROM Cardsこのクエリを実行すると、作成されたカスタムフィールドがすべて、テーブルのカラムとしてリスト化されます。カラム名はカスタムフィールド名となり、行の値はカスタムフィールドの値となります。 ドロップダウンリストタイプのカスタムフィールドの場合は、選択されたオプション名が表示されます。
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
The CData Cloud models Trello objects as relational views. A Trello object has relationships to other objects; in the views, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Trello APIs.
Cloud はTrello のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Boards | Lists all boards that are available to the user. |
| CardAttachments | Lists all the attachments of each card. |
| CardChecklists | Lists all checklists that have been created. |
| Cards | Lists all the cards from every board |
| Comments | Lists comments on cards. |
| Lists | Represents all lists created on Trello boards, including their names and positions. |
| Memberships | Lists all members associated with the boards. |
Lists all boards that are available to the user.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM Boards WHERE OrganizationId = '583558863c5859587053200c' SELECT * FROM Boards WHERE BoardId = '583558863c5859587053200c' SELECT * FROM Boards WHERE MemberId = '583558863c5859587053200c'
We can retrieve public Trello Boards by providing their Id directly to the query. You can try the query below, which tries to retrieve data from the following board https://trello.com/board/trello-development/4d5ea62fd76aa1136000000c
To get the Id of a public board, append ".json" to the board URL ( https://trello.com/b/rq2mYJNn/public-trello-boards.json for example ) and you will see something like "{"id":"4e99eb7aa9797361bc22e6ce", ...". Take that id and use it in a query.
SELECT * FROM Boards WHERE BoardId = '4d5ea62fd76aa1136000000c'
| Name | Type | ReadOnly | Description |
| BoardID [KEY] | String | True |
The Id of the Board |
| Name | String | True |
The name of the Board. |
| Description | String | True |
The description of the board. |
| Pinned | Boolean | True |
Determines if Board is pinned or not. |
| Starred | Boolean | True |
Determines if Board is starred or not. |
| Closed | Boolean | True |
Determines if Board is archived or not. |
| Url | String | True |
Board Url. |
| Subscribed | Boolean | True |
Indicates if the user is subscribed to the board. |
| DateLastActivity | Datetime | True |
Timestamp of the most recent activity on the board. |
| DateLastView | Datetime | True |
Time when it board was last viewed. |
| CreationMethod | String | True |
Indicates how the board was created. |
| MemberID | String | True |
References the member of the board. |
| OrganizationID | String | True |
References the organization of which the board is part of. |
| EnterpriseOwned | Boolean | True |
Determines if the board is enterprise owned. |
| PermissionLevel | String | True |
Permission level of the board (private, organization, public). |
| HideVotes | Boolean | True |
Determines if votes can be shown or not. |
| Voting | String | True |
Determines if voting is allowed. |
| Comments | String | True |
Determines the user level which can comment. |
| Invitations | String | True |
Determines the user level which can invite. |
| SelfJoin | Boolean | True |
Determines if self join is enabled. |
| IsTemplate | Boolean | True |
Determines if the board is a template. |
| CardCovers | Boolean | True |
Determines if cards should have covers or not. |
| CardAging | String | True |
Determines what style the cards will get if they stay for too long in a list. |
| CalendarFeedEnabled | Boolean | True |
Determines if the calendar feed is enabled. |
| Background | String | True |
Background color. |
| BackgroundImage | String | True |
Background image. |
| BackgroundImageScaled | String | True |
Background image. |
| BackgroundTile | String | True |
Background tile. |
| BackgroundBrightness | String | True |
Background brightness. |
| BackgroundColor | String | True |
Background color. |
| BackgroundBottomColor | String | True |
Bottom background color. |
| BackgroundTopColor | String | True |
Top background color. |
| CanBePublic | Boolean | True |
Determines if the board can be public. |
| CanBeEnterprise | Boolean | True |
Determines if the board can be enterprise. |
| CanBeOrg | Boolean | True |
Determines if the board can be an organization. |
| CanBePrivate | Boolean | True |
Determines if the board can be private. |
| CanInvite | Boolean | True |
Determines if invitations are enabled. |
| MyCustomFieldName | String | True |
A JSON aggregates value containing the custom fields of the board. To retrieve these, IncludeCustomFields property must be enabled and a BoardId must be specified. |
Lists all the attachments of each card.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM CardAttachments WHERE BoardId = '5835594ee003411c6abdbfbd'
| Name | Type | ReadOnly | Description |
| CardID [KEY] | String | True |
The Id of the Card. |
| AttachmentId [KEY] | String | True |
The Id of the Attachment. |
| Name | String | True |
Filename of the Attachment. |
| BoardID | String | True |
The Id of the Board referencing the card with attachment. |
Lists all checklists that have been created.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM CardCheckLists WHERE BoardId = '4e99eb7aa9897361bc22e6ce' SELECT * FROM CardCheckLists WHERE CardId = '5cd4655f9c12a516f688b296'
| Name | Type | ReadOnly | Description |
| CheckListId [KEY] | String | True |
The Id of the checklist. |
| Name | String | False |
The name of the checklist. |
| Position | Double | False |
The position of the checklist. |
| CardID | String | False |
The Id of the card with the checklist. |
| BoardID | String | True |
The Id of the board referencing the card with the checklist. |
Lists all the cards from every board
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side: Closed column determines if the Card has been archived or not.
The query above will return all cards found regardless of whether they are archived or not.
SELECT * FROM Cards WHERE Closed = 'false'
The query above will return all the cards that are not archived.
SELECT * FROM Cards WHERE ListID = '4e99eb7aa9797361bc22e6d5' SELECT * FROM Cards WHERE BoardID = '4e99eb7aa9797361bc22e6ct' SELECT * FROM Cards WHERE Closed = 'true'
To insert a new Card in table Cards you have to specify a Name and a ListId in the insert statement.
Columns Name, Description, ListID, MemberIds, LabelIds and Due can be used for insert where ListId is.
Columns MemberIds and LabelIds are comma separated list of member/label ids.
Example of inserting a new Card:
INSERT INTO Cards (Name, Description, ListID, MemberIds, LabelIds, Due) VALUES ('new Card', 'new card description', 'list_id', 'member_id_1, member_id_2', 'label_id_1,label_id_2', '2019-09-18')
To execute an update to table Cards you have to specify the CardId you are trying to update.
Columns Name, Description, ListID, MemberIds, LabelIds, Due and closed can be updated. Columns MemberIds and LabelIds are comma separated list of member/label ids.
Example of updating all the fields:
UPDATE Cards SET Name = 'new name', Description = 'new description', ListID = 'listId', MemberIds = 'member_id_1,member_id_2', LabelIds = 'label_id_1,label_id_2', Due = '2019-09-18' WHERE CardID = 'card_id'
To archive a card you can update its closed property to true for ex:
UPDATE Cards SET Closed = 'true' WHERE CardID = 'card_id'
To delete a card you must specify a CardID for ex:
DELETE FROM Cards WHERE CardID = 'card_id'
| Name | Type | ReadOnly | Description |
| CardId [KEY] | String | True |
The Id of the card. |
| Name | String | False |
The name of the card. |
| BoardID | String | True |
The Id of the board which the card references. |
| ListID | String | False |
The Id of the list which the card references. |
| MemberIds | String | False |
The Ids of the members assigned to card. |
| CheckListId | String | True |
The Id of the checklist which the card references. |
| LabelIds | String | False |
The Ids of the labels assigned to card. |
| CoverAttachmentId | String | True |
The Id of the attachment on the cover of the card. |
| Description | String | False |
Description of the card. |
| Closed | Boolean | False |
Determines if the card is closed or not. |
| Due | Datetime | False |
This field returns the due time if it has been assigned to card. |
| LastActivityDate | Datetime | True | |
| AttachmentCount | Int | True |
Number of total attachments in the card. |
| CreatedDate | Datetime | False |
The time when the card was created. |
| Location | Boolean | False |
Shows if Location is set in the UI. |
| StartDate | Datetime | False |
The start date of a card. |
| URL | String | False |
URL of the card. |
| ShortURL | String | False |
Short Url of the card. |
Lists comments on cards.
| Name | Type | ReadOnly | Description |
| CommentId [KEY] | String | True |
The Id of the action. |
| Type | String | True |
The action type (possible values https://developers.trello.com/reference#action-types). |
| Date | Datetime | True |
Date created. |
| BoardID | String | True |
The Id of the board which the action references. |
| ListName | String | True |
The name of the list which the action references. |
| ListID | String | True |
The Id of the list which the action references. |
| CardID [KEY] | String | False |
The Id of the card which the action references. |
| CardName | String | True |
The name of the card which the action references. |
| CardShortLink | String | True |
The link of the card which the action references. |
| MemberId | String | True |
The Id of the member associated with the action. |
| MemberName | String | True |
The name of the member associated with the action. |
| OldPosition | String | True |
The old position of the card when you move it up or down inside a list. |
| ListAfterId | String | True |
The old position of the card when you move it up or down inside a list. |
| ListBeforeId | String | True |
The old position of the card when you move it up or down inside a list. |
| OrganizationID | String | True |
The Id of the organization which the comment references. |
| Comment | String | False |
The comment body if the action is of type commentCard. |
| CreatedDate | Datetime | True |
The time the action was created. |
Represents all lists created on Trello boards, including their names and positions.
The Cloud uses the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter executes client-side within the driver. The Closed column determines if the List has been archived or not. The following query is processed server-side.
For example:
SELECT * FROM Lists WHERE BoardId = '4e99eb7aa9797361bc22e6ct' SELECT * FROM Lists WHERE ListId = '4e99eb7aa9797361bc22e6ct'
If BoardId is specified in the connection properties, the following query returns all lists from that board.
SELECT * FROM Lists
If OrganizationId is specified in the connection properties, the following query returns all lists from boards associated with that organization.
SELECT * FROM Lists
If BoardId and OrganizationId are not specified in the connection properties, the following query returns all lists of boards that the logged-in user is part of.
SELECT * FROM Lists
| Name | Type | ReadOnly | Description |
| ListId [KEY] | String | True |
The Id of the list. |
| Name | String | False |
The name of the list. |
| Position | Double | False |
The position of the list. |
| Closed | Boolean | False |
Determines if the list is closed {archived}. |
| Subscribed | Boolean | False |
Whether the active member is subscribed to this list. |
| BoardID | String | False |
The id of the board where the list is created. |
Lists all members associated with the boards.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM Memberships WHERE BoardId = '4e99eb7aa9797361bc22e6ct'
If BoardId is not present in the connection properties or in query, for example:
SELECT * FROM Membershipsall members from all boards will be returned,
otherwise if BoardId is specified:
SELECT * FROM Membershipswill return all members of the board.
| Name | Type | ReadOnly | Description |
| MemberId [KEY] | String | True |
The Id of the member. |
| FullName | String | True |
The full name of the member. |
| UserName | String | True |
The username of the member. |
| OrganizationID | String | True |
The Id of the organization where the member is part of. |
| BoardID [KEY] | String | True |
The Id of the board that the member is part of. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Actions | Lists different actions made on Organization/Board/Card determined by type. |
| BoardPlugins | Lists all plugins enabled for each board. |
| BoardStars | Lists all the Boards that the user has starred. |
| CardLabels | Lists all labels assigned to each card. |
| CardMembers | Lists all members assigned to each card. |
| CardStickers | Lists all stickers for each card. |
| CheckListItems | Lists all items found on checklists. |
| Enterprises | Gets information about an enterprise. |
| Exports | Lists all exports of the organizations. |
| Labels | Lists all labels of the boards. |
| Notifications | Lists all notifications of the user logged. |
| OrganizationMembers | List the members in a Organization. |
| OrganizationPreferences | Lists preferences of the boards. |
| Organizations | Lists all organizations where the user is associated. |
| PluginData | Get data from plugins that have been enabled on board. |
| Reactions | Lists all Reactions made on the logged users Actions. |
| TokenPermissions | Gets information about read and write permissions. |
Lists different actions made on Organization/Board/Card determined by type.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following queries are processed server-side:
Actions differ from each other from their type.
SELECT * FROM Actions WHERE Type = 'commentCard' AND CardId = '56eae4d5eb3eb531f1ab43af'We are retrieving all comment actions made on Card with CardId = '56eae4d5eb3eb531f1ab43af'.
SELECT * FROM Actions WHERE Type = 'addMemberToBoard' AND BoardId = '5835595ee004411c6abdbfbd'We are retrieving all add member actions made on Board with BoardId = '56eae4d5eb3eb531f1ab43af'.
For a full list of actions types, visit: https://developers.trello.com/reference#action-types
If BoardId and OrganizationId are not present in the connection properties or in query ( in the case of
SELECT * FROM Actions, for example) all logged actions of the user will be returned,
otherwise if BoardId is specified,
SELECT * FROM Actionswill return all Actions of the board. Because a board can have many actions, the query may take a while to execute.
If OrganizationId is specified
SELECT * FROM Actionswill return all actions actions on the organization.
If both properties are present
SELECT * FROM Actionswill return all Actions of the board.
| Name | Type | Description |
| ActionId [KEY] | String | The Id of the action. |
| Type | String | The action type (possible values https://developers.trello.com/reference#action-types) |
| Date | Datetime | Date created. |
| BoardID | String | The Id of the board which the action references. |
| ListName | String | The name of the list which the action references. |
| ListID | String | The Id of the list which the action references. |
| CardID | String | The Id of the card which the action references. |
| CardName | String | The name of the card which the action references. |
| CardShortLink | String | The link of the card which the action references. |
| MemberId | String | The Id of the member associated with the action. |
| MemberName | String | The name of the member associated with the action. |
| OldPosition | String | The old position of the card when you move it up or down inside a list. |
| ListAfterId | String | The old position of the card when you move it up or down inside a list. |
| ListBeforeId | String | The old position of the card when you move it up or down inside a list. |
| OrganizationID | String | The Id of the organization which the action references. |
| Comment | String | The comment body if the action is of type commentCard. |
| CreatedDate | Datetime | The time the action was created. |
Lists all plugins enabled for each board.
The Cloud will use the Trello API to process the criteria columns.
Get all the plugins that are enabled in Boards.
SELECT * FROM BoardPlugins WHERE BoardId = '5835594ee003411c6abdbfbd'
| Name | Type | Description |
| ID | String | Record Id. |
| PluginId [KEY] | String | The Id of the Plugin. |
| BoardId | String | The Id of the Board. |
Lists all the Boards that the user has starred.
The Cloud will use the Trello API to retrieve data for starred boards.
| Name | Type | Description |
| ID [KEY] | String | The Id of the Board. |
| Name | String | The name of the Board. |
| Pinned | Boolean | Determines if Board is pinned or not. |
| IsClosed | Boolean | Is the board closed. |
Lists all labels assigned to each card.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM CardLabels WHERE CardId = '5cd4655f9c12a516f688b296'
| Name | Type | Description |
| CardID [KEY] | String | Id of the card holding the label. |
| LabelId [KEY] | String | Id of the label. |
| BoardID | String | Id of the board holding the card with assigned label. |
Lists all members assigned to each card.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM CardMembers WHERE CardId = '5cd4655f9c12a516f688b296'
| Name | Type | Description |
| CardID [KEY] | String | The Id of the card. |
| MemberId [KEY] | String | The Ids of the members assigned to card. |
| BoardID | String | The Id of the Board holding the card. |
| OrganizationID | String | The Id of the Organization. |
Lists all stickers for each card.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM CardStickers WHERE Name = 'thumbsdown' SELECT * FROM CardStickers WHERE BoardID = '4e99eb7aa9797361bc22e6ct'
| Name | Type | Description |
| CardID [KEY] | String | The Id of the card. |
| StickerId [KEY] | String | The Id of the sticker. |
| Name | String | Name of the sticker. |
| BoardID | String | The Id of the board referencing the card with the sticker. |
Lists all items found on checklists.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM CheckListItems WHERE CheckListId = '58e2018031e2b8e881b89b4g' SELECT * FROM CheckListItems WHERE CardId = '58e34da8446e578ac1bbb03b'
| Name | Type | Description |
| CheckListItemId [KEY] | String | The Id of the item. |
| CheckListId | String | The Id of the checklist. |
| Name | String | The name of the item. |
| State | String | The state of the item. |
| DueDate | Datetime | The due date of the item. |
| MemberId | String | The due date of the item. |
| CardID | String | The Id of the card referencing the checklist. |
| BoardID | String | The Id of the Board referencing the card with the checklist. |
Gets information about an enterprise.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
EnterpriseID needs to be specified in the query.
SELECT * FROM Enterprises WHERE EnterpriseID = '123'
| Name | Type | Description |
| EnterpriseId [KEY] | String | The Id of the enterprise. |
| Name | String | The Name of the enterprise. |
| DisplayName | String | The display name of the enterprise. |
| AdminIds | String | The Ids of the admins which are part of the enterprise. |
| MemberIds | String | The Ids of the members which are part of the enterprise. |
| OrganizationIds | String | The Ids of the organizations which are part of the enterprise. |
| Products | String | The products which are part of the enterprise. |
Lists all exports of the organizations.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
In case an OrganizationID has not been specified as a connection property, it needs to be specified in the query.
SELECT * FROM Exports WHERE OrganizationID = '123' SELECT * FROM Exports WHERE OrganizationID = '123' AND Finished = 'true' SELECT * FROM Exports WHERE OrganizationID = '123' AND Stage = 'Export_completed'
| Name | Type | Description |
| ExportID [KEY] | String | The Id of the export. |
| OrganizationID | String | The Id of the organization. |
| Attempts | Int | The number of attempts. |
| Finished | Boolean | Determines whether or not the export is finished. |
| Stage | String | The stage of which the export is. |
| Progress | Int | Determines the progress of the export. |
| StartedAt | Datetime | The date and time when the export started. |
| Size | String | The size of the export. |
| ExportUrl | String | The url where you can find the export. |
Lists all labels of the boards.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM Labels WHERE BoardId = '4e99eb7aa9797361bc22e6ct' SELECT * FROM Labels WHERE LabelId = '4e99eb7aa9797361bc22e6ct'
| Name | Type | Description |
| LabelID [KEY] | String | The Id of the label. |
| BoardID | String | The id of the board. |
| Name | String | The name of the label. |
| Color | String | The color of the label. |
Lists all notifications of the user logged.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
Notifications differ from each other from Type. A notification could be of type: addedToBoard, commentCard etc.
SELECT Text FROM Notifications WHERE Type = 'commentCard'
| Name | Type | Description |
| NotificationId [KEY] | String | The Id of the notification. |
| Type | String | The type of the notification. |
| Text | String | The text value returned if the notification is of type commentCard. |
| Date | Datetime | The date when the notification has been sent. |
| DateRead | Datetime | The date when the notification has been read. |
| Unread | Boolean | Determines if the notification has not been read. |
| MemberID | String | The Id of the member who received the notification. |
List the members in a Organization.
| Name | Type | Description |
| Id [KEY] | String | Id of the member. |
| Username | String | The username of this account. |
| FullName | String | The full name related to the account, if it is public. |
| AaEmail | String | AaEmail field of this member. |
| AaEnrolledDate | String | AaEnrolledDate field of this member. |
| AaId | String | AaId field of this member. |
| ActivityBlocked | Boolean | ActivityBlocked field of this member. |
| AvatarHash | String | AvatarHash field of this member. |
| AvatarSource | String | AvatarSource field of this member. |
| AvatarUrl | String | The url of this member's avatar. |
| Bio | String | Bio of the member. |
| BioData | String | Bio Data of the member. |
| Confirmed | Boolean | Whether the user has confirmed their email address for their account. |
| String | Email of the member. | |
| GravatarHash | String | The Gravatar Hash. |
| IdBoards | String | List of boards this member belongs to. |
| IdBoardsPinned | String | Id boards pinned of the member. |
| IdEnterprise | String | Id enterprise of the member. |
| IdEnterprisesAdmin | String | Id enterprises admin of the member. |
| IdEnterprisesDeactivated | String | Id enterprises deactivated of the member. |
| IdMemberReferrer | String | Id member referrer. |
| IdOrganizations | String | List of workspaces this member belongs to. |
| IdPremOrgsAdmin | String | IdPremOrgsAdmin field of this member. |
| Initials | String | The initials related to the account, if it is public. |
| IsAaMastered | Boolean | IsAaMastered field of this member. |
| IxUpdate | Integer | IxUpdate field of this member. |
| LimitsDisableAt | Integer | Limits disable at. |
| LimitsStatus | String | Limits status. |
| LimitsWarnAt | Integer | Limits warn at. |
| LoginTypes | String | Login types of the member. |
| MarketingDate | Datetime | Marketing opt-in date. |
| MarketingOptedIn | Boolean | Marketing opt-inOptedIn of the member. |
| MemberType | String | Type of the member. |
| MessagesDismissedId | String | Messages dismissed id of the member. |
| MessagesDismissedCount | String | Messages dismissed count of the member. |
| MessagesDismissedLastDismissed | Datetime | Messages dismissed last dismissed of the member. |
| MessagesDismissedName | String | Messages dismissed name of the member. |
| NonPublicAvailable | Boolean | Non public Available field of this member. |
| NonPublicAvatarHash | String | Non public AvatarHash field of this member. |
| NonPublicAvatarUrl | String | Non public AvatarUrl field of this member. |
| NonPublicFullName | String | Non public FullName field of this member. |
| NonPublicInitials | String | Non public Initials field of this member. |
| OneTimeMessagesDismissed | String | One time messages dismissed field of this member. |
| PrefsColorBlind | Boolean | Preferred ColorBlind field of this member. |
| PrefsLocale | String | Preferred Locale field of this member. |
| PrefsMinutesBeforeDeadlineToNotify | Integer | Preferred MinutesBeforeDeadlineToNotify field of this member. |
| PrefsMinutesBetweenSummaries | Integer | Preferred MinutesBetweenSummaries field of this member. |
| PrefsPrivacyAvatar | String | Preferred PrivacyAvatar field of this member. |
| PrefsPrivacyFullName | String | Preferred PrivacyFullName field of this member. |
| PrefsSendSummaries | Boolean | Preferred SendSummaries field of this member. |
| PrefsTimezone | String | The preferred timezone of this member. |
| PrefsTimezoneInfoDateNext | Datetime | Preferred TimezoneInfoDateNext field of this member. |
| PrefsTimezoneInfoOffsetCurrent | Integer | Preferred TimezoneInfoOffsetCurrent field of this member. |
| PrefsTimezoneInfoOffsetNext | Integer | Preferred TimezoneInfoOffsetNext. |
| PrefsTimezoneInfoTimezoneCurrent | String | Preferred TimezoneInfoTimezoneCurrent field of this member. |
| PrefsTimezoneInfoTimezoneNext | String | Preferred TimezoneInfoTimezoneNext field of this member. |
| PrefsTwoFactorEnabled | Boolean | Preferred TwoFactorEnabled field of this member. |
| PrefsTwoFactorNeedsNewBackups | Boolean | Preferred TwoFactorNeedsNewBackups field of this member. |
| PremiumFeatures | String | Premium features of the member. |
| Products | Integer | Products of the member. |
| Status | String | Status of the member. |
| Trophies | String | Trophies of the member. |
| UploadedAvatarHash | String | Uploaded avatar hash. |
| UploadedAvatarUrl | String | Uploaded avatar url. |
| Url | String | Url field of this member. |
| OrganizationId [KEY] | String | The Id of the organization where the member is part of. |
Lists preferences of the boards.
| Name | Type | Description |
| OrganizationId [KEY] | String | The Id of the Organization. |
| OrganizationName | String | The Name of the Board. |
| PermissionLevel | String | Permission level of the board (private, organization, public). |
| ExternalMembersDisabled | Boolean | Whether non-team members can be added to boards inside the team. |
| AssociatedDomain | String | The domain associated with the organization. |
| GoogleAppsVersion | Int | Google application version. |
| BoardVisibilityRestrictPrivate | String | Who can make private boards. One of: admin, none, org. |
| BoardVisibilityRestrictOrg | String | Who on the team can make team visible boards. One of admin, none, org. |
| BoardVisibilityRestrictPublic | String | Who on the team can make public boards. One of: admin, none, org. |
Lists all organizations where the user is associated.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM Organizations
| Name | Type | Description |
| OrganizationID [KEY] | String | The Id of the organization. |
| Name | String | The name of the organization. |
Get data from plugins that have been enabled on board.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
CardID needs to be specified in the query for ex.
SELECT * FROM PluginData WHERE CardID = '58355989b87aab776a356f76'
| Name | Type | Description |
| ID [KEY] | String | The record Id. |
| PluginId | String | The id of the plugin. |
| CardID [KEY] | String | The id of the card. |
| Value | String | The value returned from the plugin. |
| Access | String | Determines if plugin data has shared or private access. |
| Scope | String | The scope of the plugin data. |
Lists all Reactions made on the logged users Actions.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
ActionId needs to be specified in the query for ex.
SELECT * FROM Reactions WHERE ActionId = '5cf527965bd25809b8c75f0b' SELECT * FROM Reactions WHERE ActionId = '5cf527965bd25809b8c75f0b' AND EmojiShortName = 'rage'
| Name | Type | Description |
| ReactionId [KEY] | String | The Id of the reaction. |
| ActionId | String | The Id of the action where the reaction was made. |
| MemberId | String | The Id of the member who made the reaction. |
| MemberFullName | String | The full name of the member who made the reaction. |
| MemberInitials | String | The initials of the member who made the reaction. |
| MemberUsername | String | The username of the member who made the reaction. |
| EmojiUnified | String | The code of the emoji. |
| EmojiName | String | The name of the emoji. |
| EmojiNative | String | The native of the emoji. |
| EmojiSkinVariation | String | The color of the emoji. |
| EmojiShortName | String | The short name of the emoji. |
Gets information about read and write permissions.
The Cloud will use the Trello API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver. For example, the following query is processed server-side:
SELECT * FROM TokenPermissions WHERE ModelId = '5ccad9ab1747f81fb1493569'
| Name | Type | Description |
| TokenId [KEY] | String | The Id of the Token. |
| ModelId [KEY] | String | The Id of the Model. |
| ModelType | String | The Type of the Model. |
| CanRead | Bool | Determines if the model has read permissions. |
| CanWrite | Bool | Determines if the model has write permissions. |
ストアドプロシージャはファンクションライクなインターフェースで、Trello の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにTrello から関連するレスポンスデータを返します。
| Name | Description |
| CreateBoards | Create a new board. |
| CreateLists | Uploads an attachment to a specific card. You must provide either AttachmentPath, Content/FileName, or URL. Each input takes precedence over the next. |
| GetMemberInfo | Retrieves information regarding a member. |
Create a new board.
| Name | Type | Required | Description |
| Name | String | True | The new name for the board. |
| Description | String | False | The description for the board. |
| OrganizationId | String | False | The id or name of the Workspace the board should belong to. |
| UseDefaultLabels | Boolean | False | Determines whether to use the default set of labels. Default: true. |
| UseDefaultLists | Boolean | False | Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if `SourceBoardId` is provided. Default: true. |
| SourceBoardId | String | False | The id of a board to copy into the new board. |
| KeepCardsFromSource | Boolean | False | To keep cards from the original board pass in the value `true`. |
| PowerUps | String | False | The Power-Ups that should be enabled on the new board.
使用できる値は次のとおりです。all, calendar, cardAging, recap, voting |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
| ErrorMessage | String | Error message for an unsuccessful operation. |
| BoardId | String | The ID of the newly created board. |
Uploads an attachment to a specific card. You must provide either AttachmentPath, Content/FileName, or URL. Each input takes precedence over the next.
| Name | Type | Required | Description |
| Name | String | True | Name for the list. |
| BoardId | String | True | The long Id of the board the list should be created on. |
| SourceListId | String | False | Id of the List to copy into the new list. |
| Position | String | False | Position of the list.
使用できる値は次のとおりです。top, bottom |
| Name | Type | Description |
| Success | String | This value shows a boolean indication of whether the operation was successful or not. |
| ErrorMessage | String | Error message for an unsuccessful operation. |
| ListId | String | The Id of the newly created list. |
Retrieves information regarding a member.
| Name | Type | Required | Description |
| MemberId | String | False | Id of the member to get information. If not specified, information regarding the signed member will be retrieved. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the operation was successful or not. |
| Id | String | The identifier of the member. |
| String | The email of the member. | |
| FullName | String | The full name of the member. |
| UserName | String | The username of the member. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Trello のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
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 | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Cards テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Cards'
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | カラムを含むテーブルまたはビューの名前。 |
| ColumnName | String | カラム名。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | カラムのストレージサイズ。 |
| DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
| NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
| IsNullable | Boolean | カラムがNull を含められるかどうか。 |
| Description | String | カラムの簡単な説明。 |
| Ordinal | Int32 | カラムのシーケンスナンバー。 |
| IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
| IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
| IsHidden | Boolean | カラムが非表示かどうか。 |
| IsArray | Boolean | カラムが配列かどうか。 |
| IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
| IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
| ColumnType | String | スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、DownloadAttachment ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadAttachment' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'DownloadAttachment' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| DataTypeName | String | データ型の名前。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| Values | String | このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。 |
| SupportsStreams | Boolean | パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。 |
| IsPath | Boolean | パラメータがスキーマ作成操作のターゲットパスかどうか。 |
| Default | String | 何も値が指定されていない場合に、このパラメータで使用される値。 |
| SpecificName | String | 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。 |
| IsCDataProvided | Boolean | プロシージャがネイティブのTrello プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、Cards テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Cards'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。) |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ(例:Source、Destination)。 |
| プロパティ | 説明 |
| AuthScheme | The scheme used for authentication. Accepted entries are Token and OAuth. |
| APIKey | The Trello API key. |
| Token | The Trello Token. |
| プロパティ | 説明 |
| OrganizationId | The Trello OrganizationId. |
| BoardId | The Trello BoardId. |
| MemberId | The Trello MemberId. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
| AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| IncludeCustomFields | Determines if the custom fields created on a card will be shown. |
| IncludeOrganizationBoards | IncludeOrganizationBoards determines if the logged in user has organizations or an enterprise of its own. And want to retrieve data from both organization and personal boards. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The scheme used for authentication. Accepted entries are Token and OAuth. |
| APIKey | The Trello API key. |
| Token | The Trello Token. |
The scheme used for authentication. Accepted entries are Token and OAuth.
string
"OAuth"
This field is used to authenticate to Trello. OAuth is the default option.
The Trello API key.
string
""
The Trello API key is used alongside Token to authenticate using Trello's own authorization route.
The Trello Token.
string
""
The Trello Token key is used alongside APIKey to authenticate using Trello's own authorization route.
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| OrganizationId | The Trello OrganizationId. |
| BoardId | The Trello BoardId. |
| MemberId | The Trello MemberId. |
The Trello OrganizationId.
string
""
The Trello OrganizationId references a specific Trello organization. If specified the range of some queries will be bound to that organization. For example:
SELECT * FROM Listswill return all lists of the boards on that organization.
SELECT * FROM Membershipswill return all members of the organization.
SELECT * FROM Actionswill return all actions on the organization.
The Trello BoardId.
string
""
The Trello BoardId references a specific Trello board. If specified the range of some queries will be bound to that board. For example:
SELECT * FROM Listswill return all lists of the board.
SELECT * FROM Membershipswill return all members of the board.
SELECT * FROM Actionswill return all Actions of the board. Given that a board can have many actions, the query may take a while to execute.
The Trello MemberId.
string
""
The Trello MemberId references a specific Trello member. If specified, the range of some queries will be bound to that member. For example:
SELECT * FROM Actionswill return all actions of that member.
SELECT * FROM Boardswill return all boards that both the logged user and member specified have in common.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
| AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
string
""
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
string
""
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
string
""
スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。
InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。
InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。
OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
string
""
このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。
GetOAuthAccessToken ストアドプロシージャでAuthKey とともに指定して、OAuthAccessToken を取得できます。
OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
string
""
このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。
GetOAuthAccessToken ストアドプロシージャでAuthToken とともに指定して、OAuthAccessToken を取得できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeCustomFields | Determines if the custom fields created on a card will be shown. |
| IncludeOrganizationBoards | IncludeOrganizationBoards determines if the logged in user has organizations or an enterprise of its own. And want to retrieve data from both organization and personal boards. |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
Determines if the custom fields created on a card will be shown.
bool
true
Custom Fields is one of the most popular power ups found on Trello. To begin using Custom fields, first activate the power up in your Trello board and create/add custom fields to your cards. After you are done setting up the power up and adding custom fields, they will appear as columns in the Cards table. Set this property to false if you do not want custom fields to show up.
Please note that you must also specify the BoardId in the connection string. This connection property is used for retrieving custom fields that have been created on Trello's cards.
SELECT * FROM CardsRunning the query above will list all the custom fields created as table columns.
IncludeOrganizationBoards determines if the logged in user has organizations or an enterprise of its own. And want to retrieve data from both organization and personal boards.
bool
false
If IncludeOrganizationBoards is set to true the provider will retrieve all data from all the boards that the logged user has access to. In contrary it will retrieve data only from the boards where the logged in user is a member of.
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.