CData Cloud offers access to Slack across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Slack through CData Cloud.
CData Cloud allows you to standardize and configure connections to Slack as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Slack in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Slack and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Slack through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Slack by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.
The following subsections describe how to authenticate to Slack from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Slack, see Connection.
CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Slack via a desktop application or a headless machine. (For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Slack".)
However, you must create a custom OAuth application to connect to Slack via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.
Custom OAuth applications are useful if you want to:
Creating the OAuth application obtains two OAuth client credentials: OAuthClientId and OAuthClientSecret.
After creating your application, define its CallbackURL:
In order to use all possible features, you must specify the required scopes in the GetOAuthAuthorizationURL and GetOAuthAccessToken procedures, and within the application itself.
To configure the appropriate scopes within the OAuth application:
Required Scopes:
channels:read, groups:read, im:read, mpim:read, channels:write, groups:write, im:write, mpim:write, channels:history, groups:history,
im:history, mpim:history, search:read, chat:write:user, chat:write:bot, files:read, files:write:user, pins:read, pins:write, usergroups:read,
usergroups:write, reminders:read, reminders:write, users:read, users.profile:write.
These values are all sent as default scopes in the GetOAuthAuthorizationURL and GetOAuthAccessToken procedures,
By default, the Cloud 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 Cloud models the Slack APIs as Tables and Stored Procedures.
The stored procedures are function-like interfaces to Slack that enable you to work with other aspects of the Slack API. They can be used to search, update, and modify information in Slack.
The tables and stored procedures are defined in static schema files, making them easy to customize.
The Cloud models the data in Slack as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
Calls | Register,update,end or return information about a Call. |
Channels | Create, update, and query the available channels in Slack. |
Files | Query and delete team files. |
MessageReplies | Create, update, delete, and query threads of messages posted to a conversation. |
Messages | Create, update, delete, and query the available messages in Slack. |
Pins | Create, delete, and query all items pinned to a channel. |
Reactions | Create, delete, and query reactions on items. |
Reminders | Create, delete, and query all reminders by or for a given user. |
UserGroups | Create, update, and query all User Groups for a Slack team. |
Users | Update and query all users for a Slack team. |
Register,update,end or return information about a Call.
You must specify the Id column in the WHERE clause to query the Calls table.
The Cloud will use the Slack API to process search criteria that refer to the Id column. This column supports server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.
For example, the following query is processed server side:
SELECT * FROM Calls WHERE Id = 'R04HH525YBS'
Inserts are allowed when you specify the ExternalUniqueId and JoinURL. For example:
INSERT INTO Calls (ExternalUniqueId, JoinURL) VALUES (uniqId, joinurl)
Updates are allowed when you specify the Id.
UPDATE Calls SET JoinURL = 'join', Title = 't' WHERE Id = 'R04HH525YBS'
You can delete a pin by providing the Id.
DELETE FROM Calls WHERE id = 'R04HH525YBS'
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
Id of the call. |
DateStart | Datetime | True |
Start time of the call. |
DesktopAppJoinURL | String | False |
The desktop app join url of the call. |
ExternalDisplayId | String | False |
The external display of the call. |
ExternalUniqueId | String | False |
The external unique Id of the call. |
JoinURL | String | False |
The joining url of the call. |
Title | String | False |
The title of the call. |
Users | String | True |
The users involved in the call. |
Create, update, and query the available channels in Slack.
The Cloud will use the Slack API to process search criteria that refer to the Id, IsArchived, IsPublic, IsGroup, IsDirectMessage, and IsMultipartyDirectMessage columns. These columns support server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.
For example, the following queries are processed server side by the Slack APIs:
SELECT * FROM Channels WHERE IsPublic = false AND IsGroup = false AND IsArchived = true SELECT * FROM Channels WHERE Id = 'D71R6CSR1'
The Name column is the minimum requirement for an insert. Name and IsPublic are the only columns that can be set on an insert.
INSERT INTO Channels (Name, IsPublic) VALUES ('initialname', true)
The Channels table allows updates for columns Name, Purpose, and Topic when Id is specified.
UPDATE Channels SET Topic = 'A Topic Text', Purpose = 'A Purpose Text', Name = 'updatedname' WHERE Id = 'D71R6CSR1'
Slack does not allow Channels to be deleted.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the channel. |
Name | String | False |
The name of the channel. |
Topic | String | False |
Information about the channel topic. |
TopicCreator | String | True |
Creator of the channel topic. |
Purpose | String | False |
Information about the channel purpose. |
TotalMembers | Integer | True |
Number of members in the channel. |
Created | Datetime | True |
Channel creation datetime. |
Creator | String | True |
User ID of the member that created this channel. |
LastRead | Datetime | True |
The datetime for the last message the calling user has read in this channel. |
IsMember | Boolean | True |
Indicates the user or bot user or Slack app associated with the token making the API call is itself a member of the conversation. |
IsArchived | Boolean | True |
Indicates a conversation is archived. Frozen in time |
IsPublic | Boolean | False |
Indicates whether a conversation is a public channel. Everything said in a public channel can be read by anyone else belonging to a workspace. |
IsGroup | Boolean | True |
Indicates whether the channel is a private channel between a group of members. |
IsDirectMessage | Boolean | True |
Means the conversation is a direct message between two distinguished individuals or a user and a bot. |
IsMultipartyDirectMessage | Boolean | True |
Represents an unnamed private conversation between multiple users. |
IsGeneral | Boolean | True |
Means the channel is the workspace's 'general' discussion channel. |
Unlinked | Integer | True |
Number of times a link to the channel has been removed. |
NameNormalized | String | True |
Normalized name of the channel. |
IsShared | Boolean | True |
Means the conversation is in some way shared between multiple workspaces. |
IsExtShared | Boolean | True |
Represents this conversation as being part of a Shared Channel with a remote organization. |
IsOrgShared | Boolean | True |
Explains whether this shared channel is shared between Enterprise Grid workspaces within the same organization. |
IsPendingExtShared | Boolean | True |
It means the conversation is ready to become an IsExtShared channel but isn't quite ready yet and needs some kind of approval or sign off. |
PreviousNames | String | True |
A list of previous names this channel has had. |
Locale | String | True |
Locale of the channel. |
User | String | True | |
IsUserDeleted | Boolean | True | |
Priority | String | True |
Query and delete team files.
The Cloud will use the Slack API to filter by search criteria that refer to the Id, Created, UserId, Types, SpecificChannel, or SearchTerm columns. All columns support server-side processing for the = operator, and the Created column also supports server-side processing for the >, >=, <, <= operators.
The Cloud processes other search criteria client-side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM Files WHERE Created > '2017-01-01' AND UserId = 'U2345NDS' AND SpecificChannel = 'D71R6CSR1'
You can also filter files by querying the files' contents: Set the SearchTerm pseudocolumn in the criteria. All files containing the queried word will be retrieved. For example:
SELECT * FROM Files WHERE SearchTerm = 'text'
Slack does not allow inserting new files.
Slack does not allow updating files.
Files can be deleted by providing the Id of the file.
DELETE FROM Files WHERE Id = 'F71R6DRR1'
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the file. |
Name | String | True |
The name of the file. It may nbe null for unnamed files |
Title | String | True |
The title of the file. |
Created | Datetime | True |
Creation date of the file. |
UserId | String | True |
User ID of the member that created this file. |
Username | String | True |
Username of the file creator. |
InitialComment | String | True |
A comment from the file uploader, and will only be set when the uploader left a comment at the time of upload. |
Size | Integer | True |
The filesize in bytes. Snippets are limited to a maximum file size of 1 megabyte |
Filetype | String | True |
The type of the file. |
Mimetype | String | True |
Mime type of the file. |
PrettyType | String | True |
Human-readable version of the type. |
CommentsCount | Integer | True |
Number of comments made on the file. |
Mode | String | True |
A property that contains one of hosted, external, snippet or post. |
PublicChannelIds | String | True |
A list of channel IDs in which the file is currently shared. |
GroupIds | String | True |
A list of private groups IDs in which the file is currently shared. |
DirectMessageIds | String | True |
A list of instant message IDs in which the file is currently shared. |
Editable | Boolean | True |
Indicates that files are stored in editable mode. |
Permalink | String | True |
URL that points to a single page for the file containing details, comments and a download link. |
PermalinkPublic | String | True |
If the file is available to the public, this URL points to the public file itself. |
EditLink | String | True |
Present for posts and snippets. The page where the file can be edited |
UrlPrivate | String | True |
Points to a URL to the file contents. |
UrlPrivateDownload | String | True |
For editable-mode files, this parameter includes headers to force a browser download. |
Thumb480 | String | True |
Contains the URL of an 480x480 thumb. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
SpecificChannel | String |
Filter files appearing in a specific channel, indicated by its ID. |
SearchTerm | String |
Filter by this column to retrieve all files that contain the word in the criteria. |
Types | String |
Filter files by type. Allowed values are all,spaces,snippets,images,gdocs,zips. Default value is all. The allowed values are all, spaces, snippets, images, gdocs, zips. |
Create, update, delete, and query threads of messages posted to a conversation.
The MessageReplies table requires the ChannelId And ParentMessageId columns in the WHERE clause. Search criteria that refer to other columns are processed client-side within the Cloud.
For example, the following query is processed server side:
SELECT * FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND ParentMessageId = '1234567890.123456'
Slack allows inserts only when ChannelId, Text, and ParentMessageId are specified.
INSERT INTO MessageReplies (ChannelId, Text, ParentMessageId) VALUES ('D71R6CSR1', 'This is a message', '1234567890.123456')
The MessageReplies table allows updates only for the Text field. Specify ChannelId and Id.
UPDATE MessageReplies SET Text = 'Updated message' WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456'
MessageReplies can be deleted by providing the ChannelId and the Id of the message.
DELETE FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
Unique identifier for the messages. |
ChannelId [KEY] | String | False |
Conversation ID to fetch thread from. |
UserId | String | True |
User Id of the user who posted the reply. |
Text | String | False |
Reply message content. |
ParentMessageId [KEY] | String | False |
Unique identifier of a thread's parent message. |
ReplyCount | Integer | True |
The replies number for thread's parent message. |
Subscribed | Boolean | True |
Indicates if the user is subscribed to this channel. |
LastRead | Datetime | True |
The datetime for the last message the calling user has read in this channel. |
UnreadCount | Integer | True |
The number of members that have not read the parent message. |
Create, update, delete, and query the available messages in Slack.
The Messages table requires ChannelId or SearchTerm in the WHERE clause. The Cloud also uses the Slack API to process search criteria that refer to the Id column. The ChannelId, SearchTerm, and Id columns support server-side processing for the = operator. The Cloud processes other search criteria client-side within the Cloud.
SELECT * FROM Messages WHERE ChannelId = 'D71R6CSR1' SELECT * FROM Messages WHERE SearchTerm = 'text' SELECT * FROM Messages WHERE CreatedTime >= '7-30-2023 00:00:00' AND CreatedTime <= '8-4-2023 00:00:00'
Slack allows inserts only when ChannelId and Text are specified.
INSERT INTO Messages (ChannelId, Text) VALUES ('D71R6CSR1', 'This is a message')
The Messages table allows updates only for the Text field. Specify ChannelId and Id.
UPDATE Messages SET Text = 'Updated message' WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456'
Messages can be deleted by providing the ChannelId and the Id of the message.
DELETE FROM Messages WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456'
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the message. |
ChannelId [KEY] | String | False |
The Id of the channel the message was posted to. |
UserId | String | True |
The Id of the user that posted the message. |
Text | String | False |
Text of the message. |
Type | String | True |
Type of the message. |
Item_type | String | True |
Item type of the message. |
Subtype | String | True |
Subtype of the message. |
Team | String | True |
Team of the message. |
Pinned_to | String | False |
Pinned details of the message. |
Pinned_info_Channel | String | True |
Id of the pinned channel of the message. |
Pinned_info_pinned_by | String | True |
Id of the pinned by message. |
Pinned_info_pinned_ts | String | True |
Id of the pinned message of the message. |
AttachmentsAggregate | String | True |
Attachments made to the message. |
Purpose | String | False |
Purpose of the message. |
BotId | String | True |
BotId of the message. |
BotLink | String | True |
BotLink of the message. |
Username | String | True |
UserName of the message. |
Reply_count | Integer | False |
Count of the replied channels to the message. |
Reply_users_count | Integer | False |
Count of the replied users to the message. |
Latest_reply | String | True |
Latest message reply of the message. |
Last_read | String | True |
Last read message. |
Reply_usersAggreagte | String | True |
Replied user details of the message. |
Subscribed | Boolean | True |
Subscribed status of the message. |
Topic | String | True |
Topic of the message. |
Old_name | String | False |
Old Name of the message. |
Name | String | False |
Name of the message. |
SearchTerm | String | True |
Filter by this column to retrieve all messages that contain the word in the criteria. |
UserEditedDate | String | True |
The date of the edited message. |
UserEditedId | String | True |
The user id of the edited message. |
CreatedTime | Datetime | True |
The created date time of the message. |
Create, delete, and query all items pinned to a channel.
You must specify the ChannelId column in the WHERE clause to query the Pins table.
The Cloud will use the Slack API to process search criteria that refer to the ChannelId column. This column supports server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.
For example, the following query is processed server side:
SELECT * FROM Pins WHERE ChannelId = 'D71R6CSR1'
INSERTS are allowed when you specify the ChannelId, Id, and Type. For example:
INSERT INTO Pins (ChannelId, Id, Type) VALUES ('D71R6CSR1', 'F71R6DRR1', 'file')
Slack does not support UPDATE for pins.
You can delete a pin by providing the ChannelId, Id, and Type.
DELETE FROM Pins WHERE ChannelId = 'D71R6CSR1' AND Id = '1505287261.000226' AND Type = 'message'
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The Id of the pinned item. |
Type [KEY] | String | False |
The type of the pinned item. The allowed values are message, file, file comment. |
Created | Datetime | True |
A unique datetime representing when the item was pinned. |
ChannelId [KEY] | String | False |
Channel Id to get pinned items for. |
PinnedToChannelIds | String | True |
Comma separated list of channel ids the item is pinned to. |
CreatedBy | String | True |
The encoded user id of the user who pinned the item. |
Create, delete, and query reactions on items.
The Cloud will use the Slack API to process search criteria that refer to the Team, Users column. This column supports server-side processing for the = operator. The Cloud processes other filters client-side within the Cloud.
SELECT * FROM Reactions WHERE Users = 'U046AV8HU3G'
SELECT * FROM Reactions WHERE Team = 'T046W75LRTK'
SELECT * FROM Reactions WHERE Team = 'T046W75LRTK' AND Users = 'U046AV8HU3G'
Inserts are allowed when you specify the ChannelId, Id, Name and Type. For example:
INSERT INTO Reactions (ChannelId, Id, Type, Name) VALUES ('C04HBS2PS56', '1672114112.994259', 'message', 'raised_hands')
Slack does not support UPDATE for reactions.
You can delete a pin by providing the ChannelId, Id, Name and Type.
DELETE FROM Reactions WHERE Name = 'raised_hands' AND ChannelId = 'C04HBS2PS56' AND Id = '1672114112.994259' AND type = 'message'
Name | Type | ReadOnly | Description |
Id | String | False |
The Id of the reacted item. |
ChannelId | String | False |
The ChanneldId where item is reacted |
Type | String | False |
The type of the reacted item. The allowed values are message, file, file comment. |
Name | String | False |
The name of the reaction |
Count | String | True |
The count of reactions on that message |
Users | String | True |
The encoded user id of the user who reacted to the message. |
Team | String | True |
The name of the reaction |
Create, delete, and query all reminders by or for a given user.
The Cloud uses the Slack API to process search criteria that refer to the Id column while other filters are processed client-side within the Cloud. For example, the following query is processed server side:
SELECT * FROM Reminders WHERE Id = 'RT7U7LN6F'
Inserts are allowed when you specify the Text and Time for the reminder. You can also add UserId. For example:
INSERT INTO Reminders (Text, Time, UserId) VALUES ('Remind me for coffee', '2017-01-01 10:00', 'U723764DF')
Slack does not support UPDATE for reminders.
You can delete a reminder by providing the Id.
DELETE FROM Reminders WHERE Id = 'R71R6CSR1'
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the reminder. |
Creator | String | True |
The Id of the user who created the reminder. |
UserId | String | False |
The Id of the user the reminder is set for. |
Text | String | False |
The content of the reminder. |
Recurring | Boolean | True |
Indicates if this reminder is to be repeated. |
Time | Datetime | False |
The datetime of the reminder. |
CompleteTimestamp | Datetime | True |
The datetime when the reminder was completed. |
Create, update, and query all User Groups for a Slack team.
The Cloud uses the Slack API to process search criteria that refer to the IncludeDisabled column while other search criteria are processed client-side within the Cloud. For example, the following query is processed server side:
SELECT * FROM UserGroups WHERE IncludeDisabled = 'true'
Inserts are allowed only for paid workspaces and when you specify the Name of the user group. Other optional fields are Description, Handle, and PreferredChannelIds. For example:
INSERT INTO UserGroups (Name, PreferredChannelIds) VALUES ('newgroup', 'C5S8LAY0Y,C79J7PREU')
You can update a user group by providing the Id and you can update the UserIds, Name, Description, PreferredChannelIds, and Handle columns. Updates are only allowed for paid workspaces.
UPDATE UserGroups SET PreferredChannelIds = 'C5S8LAY0Y,C79J7PREU', Name = 'newname' WHERE Id = 'U4826PEF'
Slack does not support the deletion of user groups.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the User Group. |
Name | String | False |
Indicates the friendly name of the group. |
Description | String | False |
Explains the purpose of the group. |
TeamId | String | True |
Identifier of the team this user group belongs to. |
UserIds | String | False |
Contains a list of user id values that belong to the User Group. |
UserCount | String | True |
Indicates the total number of users in a group. |
Handle | String | False |
Indicates the value used to notify group members via a mention without a leading @ sign. |
PreferredChannelIds | String | False |
Channels that members of this group will be invited to upon joining. |
PreferredGroupsIds | String | True |
Groups (private channels) that members of this group will be invited to upon joining. |
IsExternal | Boolean | True |
Represents this conversation as being externally shared. |
DateCreated | Datetime | True |
Datetime of the creation of the user group. |
DateUpdated | Datetime | True |
Datetime that the user group became disabled. |
CreatedBy | String | True |
Id of the user who created the user group. |
UpdatedBy | String | True |
Id of the user who last modified the user group. |
DeletedBy | String | True |
Id of the user who disabled/archived the user group. |
AutoType | String | True |
This parameter's value can be admins for a Workspace Admins group, owners for a Workspace Owners group or null for a custom group. |
Pseudo column fields are used in the WHERE clause of SELECT statements. These offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
IncludeDisabled | Boolean |
A boolean set to include or exclude disabled User Groups in the retrieved data. |
Update and query all users for a Slack team.
The Cloud uses the Slack API to process search criteria that refer to the Id column, while other filters are processed client-side within the Cloud. For example, the following query is processed server side:
SELECT * FROM Users WHERE Id = 'U5SU7GU6N'
Slack does not support inserting new users.
You can update a user's FirstName, LastName, ProfileDisplayName, and ProfileEmail by providing the Id of the user. Only a team admin of a paid team can update another user's profile.
UPDATE Users SET ProfileDisplayName = 'Dis Name', ProfileEmail = '[email protected]' WHERE Id = 'U5SU7GU6N'
Slack does not support deleting users.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the User. |
FirstName | String | False |
Fist name of the user. |
LastName | String | False |
Last name of the user. |
FullName | String | True |
Full name of the user. |
ProfileDisplayName | String | False |
Display name of the user. |
ProfileEmail | String | False |
Email of the user. |
ProfileImage | String | True |
URLs to square, web-viewable image of a user's profile. |
Deleted | Boolean | True |
Indicates if the user is deactivated. |
TeamId | String | True |
Id of the Slack team the user belongs to. |
IsAdmin | Boolean | True |
Indicates whether the user administers this team. |
Color | String | True |
A field used in some clients to display a colored username. |
Timezone | String | True |
String for the geographic region. |
TimezoneLabel | String | True |
String describing the name of that timezone. |
TimezoneOffset | Integer | True |
A signed integer indicating the number of seconds to offset UTC time by. |
IsOwner | Boolean | True |
Indicates whether this user is the owner of this team. |
IsPrimaryOwner | Boolean | True |
Indicates whether this user is the primary owner of this team. |
IsRestricted | Boolean | True |
Indicates whether this user is restricted from the team . |
IsUltraRestricted | Boolean | True |
Indicates whether this user is forbidden from the team. |
Updated | Datetime | True |
A datetime that shows when the user was last updated. |
IsAppUser | Boolean | True |
A boolean value indicating if the user uses the Slack App. |
Has2fa | Boolean | True |
A boolean value indicating if the user uses Two Factor Authentication. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Slack.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Slack, along with an indication of whether the procedure succeeded or failed.
Name | Description |
CloseChannel | Closes a direct message or multiperson direct message. |
CompleteReminder | Marks a reminder as complete. |
InviteUser | Invites users to a channel. |
JoinChannel | Joins an existing conversation. |
LeaveChannel | Leaves a conversation. |
OpenChannel | Opens or resumes a direct message or multiperson direct message. |
Closes a direct message or multiperson direct message.
Name | Type | Description |
ChannelId | String | Id of the conversation to close. |
Name | Type | Description |
Success | String | The result of the procedure. |
Marks a reminder as complete.
Name | Type | Description |
Id | String | The Id of the reminder to be marked as complete |
Name | Type | Description |
Success | String | The result of the procedure. |
Invites users to a channel.
Name | Type | Description |
ChannelId | String | The Id of the public or private channel to invite user(s) to. |
Users | String | A comma separated list of user Ids. Up to 30 users may be listed. |
Name | Type | Description |
Success | String | The result of the procedure. |
Joins an existing conversation.
Name | Type | Description |
ChannelId | String | The Id of the channel to join. |
Name | Type | Description |
Success | String | The result of the procedure. |
Leaves a conversation.
Name | Type | Description |
ChannelId | String | Id of the conversation to leave. |
Name | Type | Description |
Success | String | The result of the procedure. |
Opens or resumes a direct message or multiperson direct message.
Name | Type | Description |
ChannelId | String | Resume a conversation by supplying an im or mpim's Id. Or, provide the Users field instead. |
Users | String | Comma-separated lists of users. If only one user is included, this creates a 1:1 DM. Supply a channel when not supplying users. |
Name | Type | Description |
Success | String | The result of the procedure. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Slack:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Channels table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Channels'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Channels table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Channels'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:slack:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | Whether outer joins are supported. | YES, NO |
SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | Supported 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 | Supported 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 | Supported date/time 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 | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | 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 | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated Id returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
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 OAuth and UserToken. |
OAuthVersion | The type of authentication to use when connecting to Slack. |
UserToken | Set this to use the non-expiring user token created in Slack. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Property | Description |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Team | The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
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 OAuth and UserToken. |
OAuthVersion | The type of authentication to use when connecting to Slack. |
UserToken | Set this to use the non-expiring user token created in Slack. |
The scheme used for authentication. Accepted entries are OAuth and UserToken.
string
"OAuth"
Use the following options to select your authentication scheme:
The type of authentication to use when connecting to Slack.
string
"v1"
Set this to use the non-expiring user token created in Slack.
string
""
Set this to use the non-expiring user token created in Slack.
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.
string
""
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 Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Team | The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
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 name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
string
""
The name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
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 Cloud throws an exception.