The CData Sync App provides a straightforward way to continuously pipeline your Trello data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Trello connector can be used from the CData Sync application to pull data from Trello and move it to any of the supported destinations.
The Sync App leverages the Trello API to enable access to Trello.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The Trello API can be accessed either via Trello's own Authorization Route, or via OAuth.
At the moment of registration, Trello assigns an API key and Token to the account.
To activate access via Authorization Route:
After you have secured both the API key and the Token, you are ready to make requests to the Trello API.
The following subsections describe how to authenticate to Trello from three common authentication flows:
For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Trello, see Connection.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token, do the following:
The Trello OrganizationId when you specify it in the connection string, references a specific Trello organization. If specified the range of some queries will be bound to that organization for ex.
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 actions on the organization.
The Trello BoardId when you specify it in the connection string, references a specific Trello board. If specified the range of some queries will be bound to that board for ex.
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. Because a board can have many actions the query may take a while wto execute.
The Trello MemberId when you specify it in the connection string, references a specific Trello member. If specified the range of some queries will be bound to that member for ex.
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.
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.
IncludeCustomFields already defaults to true, so just specify the BoardId in the connection string and custom fields will show up. This connection property is used for retrieving custom fields that have been created on Trellos cards.
SELECT * FROM CardsRunning the query above will list all the custom fields created as table columns. The column name will be the custom field name and the row value will be the value of the custom field. In case of a custom field of type dropdown list the name of the option selected will be shown.
This section details a selection of advanced features of the Trello Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Trello and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The CData Sync App 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.
Lists all the cards from every board
The Sync App 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 |
StartDate | Datetime | False |
The start date of a card! |
Lists comments on cards.
Name | Type | ReadOnly | Description |
CommentId [KEY] | String | False |
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. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
Actions | Lists different actions made on Organization/Board/Card determined by type. |
BoardPlugins | Lists all plugins enabled for each board. |
BoardPreferences | Lists preferences of the boards. |
Boards | Lists all boards that are available to the user. |
BoardStars | Lists all the Boards that the user has starred. |
CardAttachments | Lists all the attachments of each card. |
CardChecklists | Lists all checklists that have been created. |
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. |
Checklists | Lists all checklists found on boards. |
Enterprises | Gets information about an enterprise. |
Exports | Lists all exports of the organizations. |
Labels | Lists all labels of the boards. |
Lists | Lists all the lists that have been created on boards. |
Memberships | Lists all members associated with the boards. |
Notifications | Lists all notifications of the user logged. |
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 Sync App 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 Sync App 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 preferences of the boards.
The Sync App 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 BoardPreferences WHERE BoardId = '5835594ee004411c6abdbfbc'
Name | Type | Description |
BoardId [KEY] | String | The Id of the Board. |
BoardName | String | The Name of the Board. |
PermissionLevel | String | Permission level of the board (private, organization, public). |
HideVotes | Boolean | Determines if votes can be shown or not. |
Voting | String | Determines if voting is allowed. |
Comments | String | Determines the user level which can comment. |
Invitations | String | Determines the user level which can invite. |
SelfJoin | Boolean | Determines if self join is enabled. |
IsTemplate | Boolean | Determines if the board is a template. |
CardCovers | Boolean | Determines if cards should have covers or not. |
CardAging | String | Determines what style the cards will get if they stay for too long in a list. |
CalendarFeedEnabled | Boolean | Determines if the calendar feed is enabled. |
Background | String | Background color. |
BackgroundImage | String | Background image. |
BackgroundImageScaled | String | Background image. |
BackgroundTile | String | Background tile. |
BackgroundBrightness | String | Background brightness. |
BackgroundColor | String | Background color. |
BackgroundBottomColor | String | Bottom background color. |
BackgroundTopColor | String | Top background color. |
CanBePublic | Boolean | Determines if the board can be public. |
CanBeEnterprise | Boolean | Determines if the board can be enterprise. |
CanBeOrg | Boolean | Determines if the board can be an organization. |
CanBePrivate | Boolean | Determines if the board can be private. |
CanInvite | Boolean | Determines if invitations are enabled. |
Lists all boards that are available to the user.
The Sync App 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 Starred = 'true' SELECT * FROM Boards WHERE OrganizationId = '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 | Description |
BoardID [KEY] | String | The Id of the Board |
Name | String | The name of the Board. |
Pinned | Boolean | Determines if Board is pinned or not. |
Starred | Boolean | Determines if Board is starred or not. |
Closed | Boolean | Determines if Board is archived or not. |
Url | String | Board Url. |
DateLastView | Datetime | Time when it board was last viewed. |
MemberID | String | References the member of the board. |
OrganizationID | String | References the organization of which the board is part of. |
MyCustomFieldName | String | My custom field. |
Lists all the Boards that the user has starred.
The Sync App 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 the attachments of each card.
The Sync App 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 CardId = '56eae4d5eb3eb531f1ab43af' SELECT * FROM CardAttachments WHERE BoardId = '5835594ee003411c6abdbfbd'
Name | Type | Description |
CardID [KEY] | String | The Id of the Card. |
AttachmentId [KEY] | String | The Id of the Attachment. |
Name | String | Filename of the Attachment. |
BoardID | String | The Id of the Board referencing the card with attachment. |
Lists all checklists that have been created.
The Sync App 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 | Description |
CardID [KEY] | String | The Id of the card where the checklist was created. |
CheckListId [KEY] | String | The Id of the Checklist. |
BoardID | String | Id of the board referencing the card with the checklist. |
Lists all labels assigned to each card.
The Sync App 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 Sync App 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 Sync App 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 Sync App 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. |
Lists all checklists found on boards.
The Sync App 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 CheckLists WHERE CardId = '58e34da8446e578ac1bbb03b' SELECT * FROM CheckLists WHERE BoardID = '58e2018031e2b8e881b89b4g' SELECT * FROM CheckLists WHERE ChecklistId = '58e2018031e2b8e881b89b4g'
Name | Type | Description |
ChecklistId [KEY] | String | The Id of the checklist. |
Name | String | The name of the checklist. |
CardID | String | The Id of the card with the checklist. |
BoardID | String | The Id of the board referencing the card with the checklist. |
Gets information about an enterprise.
The Sync App 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 Sync App 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 Sync App 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 the lists that have been created on boards.
The Sync App 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. Closed column determines if the List has been archived or not. For example, the following query is processed server-side:
SELECT * FROM Lists WHERE BoardId = '4e99eb7aa9797361bc22e6ct' SELECT * FROM Lists WHERE ListId = '4e99eb7aa9797361bc22e6ct'
If BoardId is specified in connection properties,
SELECT * FROM Listswill return all lists of the board.
If OrganizationId is specified in connection properties
SELECT * FROM Listswill return all lists of the boards on that organization.
If BoardId and OrganizationId are not specified in connection properties
SELECT * FROM Listswill return all lists of the boards that the logged user is part of.
Name | Type | Description |
ListId [KEY] | String | The Id of the list. |
Name | String | The name of the list. |
Position | Double | The position of the list. |
BoardID | String | The id of the board where the list is created. |
Closed | Boolean | Determines if the list is closed {archived}. |
Lists all members associated with the boards.
The Sync App 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 and OrganizationId are not present in the connection properties or in query ( for example,
SELECT * FROM Memberships) all members from all boards will be returned,
otherwise if BoardId is specified,
SELECT * FROM Membershipswill return all members of the board.
If OrganizationId is specified,
SELECT * FROM Membershipswill return all members of the organization.
If both properties are present,
SELECT * FROM Membershipswill return all members of the organization.
Name | Type | Description |
MemberId [KEY] | String | The Id of the member. |
FullName | String | The full name of the member. |
UserName | String | The username of the member. |
OrganizationID [KEY] | String | The Id of the organization where the member is part of. |
BoardID [KEY] | String | The Id of the board that the member is part of. |
Lists all notifications of the user logged.
The Sync App 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. |
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 Sync App 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 Sync App 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 Sync App 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 Sync App 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. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
AuthScheme | The scheme used for authentication. Accepted entries are Auto,Token and OAuth. |
APIKey | The Trello API key. |
Token | The Trello Token. |
Property | Description |
OrganizationId | The Trello OrganizationId. |
BoardId | The Trello BoardId. |
MemberId | The Trello MemberId. |
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
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 | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
AuthScheme | The scheme used for authentication. Accepted entries are Auto,Token and OAuth. |
APIKey | The Trello API key. |
Token | The Trello Token. |
The scheme used for authentication. Accepted entries are Auto,Token and OAuth.
This field is used to authenticate to Trello. Auto is the default option.
The Trello API key.
The Trello API key is used alongside Token to authenticate using Trello's own authorization route.
The Trello Token.
The Trello Token key is used alongside APIKey to authenticate using Trello's own authorization route.
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
Property | Description |
OrganizationId | The Trello OrganizationId. |
BoardId | The Trello BoardId. |
MemberId | The Trello MemberId. |
The Trello OrganizationId.
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.
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.
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.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
The client Id assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
The authentication token used to request and obtain the OAuth Access Token.
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
The authentication secret used to request and obtain the OAuth Access Token.
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the Sync App opens a connection to Trello and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Trello Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
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 | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Determines if the custom fields created on a card will be shown.
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.
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.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Cards WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.