Cloud

Build 25.0.9434
  • Slack
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリケーションの作成
      • OAuth スコープとエンドポイント
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • Bookmarks
        • Calls
        • Channels
        • ConversationMembers
        • Files
        • MessageReplies
        • Messages
        • Pins
        • Reactions
        • Reminders
        • ScheduledMessages
        • UserGroups
        • UserProfile
        • Users
      • ビュー
        • Dnd
        • Team
        • TeamAccessLogs
        • TeamInfo
        • TeamProfileFields
        • TeamProfileSections
        • UsersPresence
      • ストアドプロシージャ
        • AddProfilePhoto
        • CloseChannel
        • DisableUserGroup
        • EnableUserGroup
        • EndCall
        • EndDnd
        • EndSnooze
        • GetPermaLink
        • GetTeamBillableInfo
        • InviteUser
        • JoinChannel
        • JoinMultipleChannels
        • LeaveChannel
        • OpenChannel
        • RemoveProfilePhoto
        • SendEphemeralMessage
        • SendScheduleMessage
        • SetReadCursor
        • SetSnooze
        • ShareMeMessage
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • OAuthVersion
        • UserToken
        • Token
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • ChannelType
        • MaxRows
        • PseudoColumns
        • Team
        • Timeout
        • UseSearch
    • Third Party Copyrights

Slack - CData Cloud

概要

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

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

主要機能

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

CData Cloud

はじめに

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

Slack への接続

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

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

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

CData Cloud

接続の確立

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

Slack への接続

Cloud は、次の認証メカニズムをサポートしています。

  • OAuth (Slack のOAuth 2.0 "V2" 実装とOpenId Connect 経由のOAuth がサポートされています)
  • ユーザートークン認証

OAuth

AuthScheme をOAuth に設定します。

以下のサブセクションでは、利用可能なOAuth フローを介したSlack への認証について詳しく説明します。

サポートされているOAuth 認証方法は2種類あります。設定プロセスは(カスタムアプリに設定されるスコープを除けば)すべてのOAuth メソッドで同じなので、認証に使用するアプリのタイプに合わせてCloud を設定してください。

  • 最新のSlack アプリの場合、OAuthVersion をv2 に設定します。
  • "Sign in with Slack" を使用するSlack アプリの場合は、OAuthVersion をopenid に設定します。

ユーザートークン

DEPRECATED:UserToken は非推奨です。代わりにToken プロパティを使用してください。

カスタムOAuth アプリケーションの作成 とスコープの選択後、標準的なOAuth 認証情報(クライアント、クライアントシークレット、コールバックURL)を設定するかわりに、User OAuth Token を使用して認証することができます。

トークンを使用するには、AuthScheme をUserToken に設定し、UserToken をアプリ設定のFeatures > OAuth & Permissions にある「User OAuth Token」の値に設定します。

CData Cloud

カスタムOAuth アプリケーションの作成

カスタムOAuth アプリケーションの作成

CData はOAuth アプリケーション認証情報を製品に組み込んでおり、デスクトップアプリケーションまたはヘッドレスマシン経由でSlack に接続する際に使用できます。(OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、 の デスクトップ認証セクションを参照してください。)

ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。

カスタムOAuth アプリケーションは、次のような場合に有用です。

  • 認証ダイアログのブランディングをコントロールしたいとき
  • ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
  • ユーザーからのリクエストに対する許可をカスタマイズしたいとき

手順

OAuth 資格情報のOAuthClientId、OAuthClientSecret、CallbackURL を取得するには、OAuth アプリケーションの作成が必要です。 これには、アプリケーション本体の作成、アプリケーションのコールバックURL の設定、パーミッションスコープの設定が含まれます。

アプリケーションの作成

OAuth アプリケーションを作成すると、2つのOAuth クライアント資格情報、OAuthClientId およびOAuthClientSecret が取得されます。

  1. https://api.slack.com/apps に移動します。
  2. Create New App > From scratch をクリックします。
  3. アプリケーションの名前とワークスペースを指定し、Create App をクリックします。クライアントId とクライアントシークレットは、Basic Information のApp Credentials セクションにリストされています。
  4. 今後使用するために、Client Id とClient Secret を控えておきます。

コールバックURL の設定

アプリケーションを作成したら、CallbackURL を定義します。

  1. アプリケーション設定で、Features > OAuth & Permissions に移動します。
  2. Redirect URL セクションでAdd a New Redirect URL をクリックします。
  3. コールバック URL を http://127.0.0.1:33333、もしくはお好みのポートに設定します。
  4. URLを控えておきます。

権限スコープの設定

すべての利用可能な機能を使用するには、アプリケーション自体で必要なスコープを指定する必要があります。

OAuth アプリケーションで適切なスコープを設定するには:

  1. アプリ設定で、Features > OAuth & Permissions > Scopes に移動します。
  2. 通常のユーザーを認証する場合はUser Token Scopes に、ボットユーザーを認証する場合はBot Token Scopes に移動します。
  3. Add an OAuth Scope をクリックして、Add permission by Scope or API method... というスコープセレクタを開きます。
  4. リストから目的のスコープを選択します。
  5. 目的のスコープを追加し終えるまで、ステップ3~4を繰り返します。

最新のアプリに必要なスコープ(V2 OAuth 2.0):

OAuthVersion をv2 に設定した場合(Slack のOAuth2.0 "V2" 実装)、以下のスコープを有効にします。

  • calls:read
  • calls:write
  • channels:read
  • channels:history
  • channels:write
  • chat:write
  • dnd:read
  • dnd:write
  • files:read
  • files:write
  • groups:read
  • groups:history
  • groups:write
  • im:read
  • im:history
  • im:write
  • links:read
  • links:write
  • mpim:read
  • mpim:history
  • mpim:write
  • pins:read
  • pins:write
  • reactions:read
  • reactions:write
  • reminders:read
  • reminders:write
  • search:read
  • stars:read
  • stars:write
  • team:read
  • usergroups:read
  • usergroups:write
  • users:read
  • users:read.email
  • users.profile:write

これらの値はすべて、GetOAuthAuthorizationURL およびGetOAuthAccessToken プロシージャのデフォルトスコープとして送信されます。

"Sign in with Slack" アプリに必要なスコープ(OpenID Connect):

OAuthVersion にopenid を設定した場合("Sign in with Slack" OpenID Connect フロー)、以下のスコープのみを指定します:

  • openid
  • email
  • profile

カスタムOAuth アプリケーションの配布

OAuth アプリケーションを他のワークスペースのユーザーが利用できるようにし、インストールできるようにするには:

  1. アプリケーションの設定(設定セクション)で、Manage Distribution をクリックします。
  2. コールバックURL の設定と権限の設定の手順を完了します。
  3. Activate Public Distribution をクリックします。

CData Cloud

OAuth スコープとエンドポイント

Slack に必要なスコープおよびエンドポイントドメイン

Slack と連携する場合、アプリケーションはAPI とやりとりするために特定の権限が必要です。

これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。

このトピックでは、Slack プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。

スコープについて

スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。

例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。

Slack に必要なスコープ

Scope Description
channels:read View basic information about public channels in a workspace. Required for read and write access.
groups:read View messages and other content in private channels that your Slack app has been added to. Required for read and write access.
im:read View basic information about direct messages that your Slack app has been added to. Required for read and write access.
mpim:read View basic information about group direct messages that your Slack app has been added to. Required for read and write access.
channels:history View messages and other content in public channels that your Slack app has been added to. Required for read and write access.
groups:history View messages and other content in private channels that your Slack app has been added to. Required for read and write access.
im:history View messages and other content in direct messages that your Slack app has been added to. Required for read and write access.
mpim:history View messages and other content in group direct messages that your Slack app has been added to. Required for read and write access.
search:read Search a workspace’s content. Required for read and write access.
files:read View files shared in channels and conversations that your Slack app has been added to. Required for read and write access.
pins:read View pinned content in channels and conversations that your Slack app has been added to. Required for read and write access.
usergroups:read View user groups in a workspace. Required for read and write access.
reminders:read View reminders created by your Slack app. Required for read and write access.
users:read View people in a workspace. Required for read and write access.
channels:write Manage a user’s public channels and create new ones on a user’s behalf. Required for write access.
groups:write Manage private channels that your Slack app has been added to and create new ones. Required for write access.
im:write Start direct messages with people. Required for write access.
mpim:write Start group direct messages with people. Required for write access.
chat:write:user Send messages on a user’s behalf. Required for write access.
chat:write:bot Send messages as your Slack app. Required for write access.
files:write:user Upload, edit, and delete files as your Slack app. Required for write access.
pins:write Add and remove pinned messages and files. Required for write access.
usergroups:write Create and manage user groups. Required for write access.
reminders:write Add, remove, or mark reminders as complete. Required for write access.
users.profile:write Edit a user’s profile information and status. Required for write access.

エンドポイントドメインについて

エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。

これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。

Note: ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。

Slack に必要なエンドポイントドメイン

Domain Always Required Description
slack.com TRUE The URL of the Slack API.

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

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

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

CData Cloud

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

CData Cloud

データモデル

Cloud は、Slack API をテーブル、ビュー、およびストアドプロシージャ としてモデル化します。

ストアドプロシージャはSlack のファンクションライクなインターフェースで、Slack API の他の側面を扱うことを可能にします。ストアドプロシージャを使用すると、Slack 内の情報を検索、更新、および編集できます。

テーブル、ビュー、ストアドプロシージャは、静的なスキーマファイルで定義されているため、カスタマイズが容易です。

CData Cloud

テーブル

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

CData Cloud - Slack テーブル

Name Description
Bookmarks Retrieves the list of bookmarks for the channel.
Calls Register, update, or return information about a Call.
Channels Create, update, and query the available channels in Slack.
ConversationMembers Retrieve members of a conversation.
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.
ScheduledMessages Query all scheduled messages.
UserGroups Create, update, and query all User Groups for a Slack team.
UserProfile Retrieve a user's profile information, including their custom status. This table supports only Select and Update operations.
Users Update and query all users for a Slack team.

CData Cloud

Bookmarks

Retrieves the list of bookmarks for the channel.

Select

You must specify the ChannelId column in the WHERE clause to query the Bookmarks table. The Cloud will use the Slack API to process search criteria that refer to the ChannelId 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 Bookmarks WHERE ChannelId = 'C01KWCPJJ68' 

Insert

ChannelId, Title, and Type are required for inserting a bookmark. Title, Type, Emoji, EntityId, Link, AccessLevel, and ParentId are the only columns that can be set on an insert.

INSERT INTO Bookmarks (ChannelId, Title, Type, Link) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799')

INSERT INTO Bookmarks (ChannelId, Title, Type, Link, Emoji, AccessLevel) VALUES ('C01KWCPJJ68', 'Test Bookmark', 'link', 'https://app.slack.com/archives/C01KWCPJJ68/p1735804757564799', ':clap:', 'write')

Update

The Bookmarks table allows updates for columns Title, Link, and Emoji when Id and ChannelId are specified.

UPDATE Bookmarks SET Link='https://cdatasoftware.slack.com/archives/C01KWCPJJ68/p1733740400267539' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8' 

Update Bookmarks SET Title='Test Bookmark Update' WHERE ChannelId = 'C01KWCPJJ68' and Id = 'Bk0871NJJQD8'

Delete

Bookmarks can be deleted by providing the ChannelId and the Id of the Bookmark.

DELETE FROM Bookmarks WHERE ChannelId = 'D71R6CSR1' AND Id = 'Bk0871NJJQD8' 

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the bookmark

ChannelId String True

The Id of the channel.

AppId String False

The App Id.

DateCreated Datetime True

The date when the bookmark was created.

DateUpdated Datetime True

The date when the bookmark was updated.

Emoji String False

The emoji tag added to the bookmark.

EntityId String False

The Id of the entity being bookmarked.

IconUrl String True

The URL of the icon.

LastUpdatedByTeamId String True

The Id of the team who last updated the bookmark.

LastUpdatedByUserId String True

The Id of the user who last updated the bookmark.

Link String False

Link to bookmark.

Rank String False

The rank of the bookmark.

ShortcutId String True

The shortcut Id.

Title String False

Title of the bookmark.

Type String False

Type of the bookmark. Supported values are 'link'.

Pseudo-Columns

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

Name Type Description
AccessLevel String

The level that we are setting the file's permission to (read or write).

ParentId String

Id of the bookmark's parent.

QuipSectionId String

Quip section ID to unbookmark.

CData Cloud

Calls

Register, update, or return information about a Call.

Select

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'

Insert

Inserts are allowed when you specify the ExternalUniqueId and JoinURL. For example:

INSERT INTO Calls (ExternalUniqueId, JoinURL) VALUES (uniqId, joinurl)

Update

Updates are allowed when you specify the Id.

UPDATE Calls SET JoinURL = 'join', Title = 't' WHERE Id = 'R04HH525YBS'

Delete

Slack does not allow Calls to be deleted.

Columns

Name Type ReadOnly References 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.

CData Cloud

Channels

Create, update, and query the available channels in Slack.

Select

The Cloud uses the Slack API to process search criteria that refer to the Id, IsArchived, IsPublic, IsPrivate, IsDirectMessage, IsMultipartyDirectMessage and User 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 IsArchived = true
SELECT * FROM Channels WHERE Id = 'D71R6CSR1' 
SELECT * FROM Channels WHERE User = 'U03AZBU3CMT' 

Insert

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)

Update

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' 

Delete

Slack does not allow Channels to be deleted.

Columns

Name Type ReadOnly References 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

The creator of the channel topic.

Purpose String False

Information about the channel purpose.

TotalMembers Integer True

The number of members in the channel.

Created Datetime True

The datetime of the Channel creation.

Creator String True

Users.Id

The 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 whether the user, bot user, or Slack app associated with the token making the API call is itself a member of the conversation.

IsArchived Boolean True

Indicates whether a conversation is archived.

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

Indicates whether 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

Indicates whether 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

The normalized name of the channel.

IsShared Boolean True

Indicates whether the conversation is in some way shared between multiple workspaces.

IsExtShared Boolean True

Indicates whether this conversation is part of a Shared Channel with a remote organization.

IsOrgShared Boolean True

Indicates whether this shared channel is shared between Enterprise Grid workspaces within the same organization.

IsPendingExtShared Boolean True

Indicates whether the conversation is ready to become an IsExtShared channel but needs some kind of approval or sign off.

PreviousNames String True

A list of previous names this channel has had.

Locale String True

The locale of the channel.

User String True

The Id of the user.

IsUserDeleted Boolean True

Indicates whether the user is deleted.

Priority String True

The priority of the channel.

ItemURL String True

The URL of the Channel.

IsPrivate Boolean True

Indicates whether a conversation is a private channel.

IsChannel Boolean True

Indicates whether a conversation is a channel.

IsFrozen Boolean True

Indicates whether a conversation is frozen.

PendingShared String True

The pending shared.

ContextTeamId String True

The context team Id.

Updated Timestamp True

The timestamp, in milliseconds, when the channel settings were updated (for example, the 'topic' or 'description' of the channel changed).

TopicLastSet Datetime True

Provides information about the channel topic.

ParentConversation String True

The parent conversation.

SharedTeamIds String True

The Ids of the shared teams.

PendingConnectedTeamIds String True

The Ids of the pending connected teams.

PurposeCreator String True

The creator of the channel purpose.

PurposeLastSet Datetime True

Provides information about the channel purpose.

Properties String True

Additional channel properties.

Pseudo-Columns

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

Name Type Description
TeamId String

The Id of the team. DEPRECATED.

ChannelType String

The type of channel to include or exclude in the search. To filter with channel type, UseSearch property must be enabled. Possible values are : private, private_exclude, archived, exclude_archived, private_exclude_archived, multi_workspace, org_wide, external_shared_exclude, external_shared, external_shared_private, external_shared_archived, exclude_org_shared

CData Cloud

ConversationMembers

Retrieve members of a conversation.

Select

You must specify the ChannelId column in the WHERE clause to query the ConversationMembers view.

The Cloud uses 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 ConversationMembers WHERE ChannelId = 'C01KWCPJJ68'

Delete

Members can be removed from the conversation by specifying the ChannelId and MemberId.

DELETE FROM ConversationMembers WHERE ChannelId = 'D71R6CSR1' AND MemberId = 'U03AZBU3CMT' 

Columns

Name Type ReadOnly References Description
MemberId String True

ID of the member.

ChannelId String True

Channels.Id

ID of the conversation to retrieve members for.

CData Cloud

Files

Query and delete team files.

Select

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'

Insert

Slack does not allow inserting new files.

Update

Slack does not allow updating files.

Delete

Files can be deleted by providing the Id of the file.

DELETE FROM Files WHERE Id = 'F71R6DRR1'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the file.

Name String True

The name of the file, which may be null for unnamed files.

Title String True

The title of the file.

Created Datetime True

The creation date of the file.

UserId String True

Users.Id

The user ID of the member that created this file.

Username String True

The username of the file creator.

InitialComment String True

A comment from the file uploader, which is only 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

The Mime type of the file.

PrettyType String True

The human-readable version of the type.

CommentsCount Integer True

The 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 whether files are stored in editable mode.

Permalink String True

The 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

The page where the file can be edited. This is available for posts and snippets.

UrlPrivate String True

The URL that points to the file contents.

UrlPrivateDownload String True

For editable-mode files, this parameter includes headers to force a browser download.

Thumb480 String True

The URL of a 480x480 thumbnail.

IsExternal Boolean True

Indicates whether the master copy of a file is stored within the system. If the file is external, then the URL property will point to the externally-hosted master file.

ExternalType String True

Indicates the type of external file, such as dropbox or gdoc.

IsPublic Boolean True

Indicates whether the file is public.

PublicUrlShared Boolean True

Indicates whether the file's public URL has been shared.

DisplayAsBot Boolean True

Indicates whether the file should be displayed as a bot.

ImageExifRotation Integer True

Image Exchangeable Image File Format (EXIF) Rotation.

OriginalW Integer True

The width dimensions of the original file.

OriginalH Integer True

The height dimensions of the original file.

DeanimateGif String True

Deanimate gif.

PJpeg String True

The progressive JPEG (PJpeg).

IsStarred Boolean True

Indicates whether the calling user has starred the file, else it is omitted.

HasRichPreview Boolean True

Indicates whether the file has rich preview.

Thumb64 String True

The URL of a 64x64 thumbnail.

Thumb80 String True

The URL of a 80x80 thumbnail.

Thumb160 String True

The URL of a 160x160 thumbnail.

Thumb360 String True

The URL of a 360x360 thumbnail.

Thumb720 String True

The URL of a 720x720 thumbnail.

Thumb960 String True

The URL of a 960x960 thumbnail.

Thumb1024 String True

The URL of a 1024x1024 thumbnail.

Thumb360W Integer True

The width dimensions for a 360x360 thumbnail.

Thumb360H Integer True

The height dimensions for a 360x360 thumbnail.

Thumb480W Integer True

The width dimensions for a 480x480 thumbnail.

Thumb480H Integer True

The height dimensions for a 480x480 thumbnail.

Thumb360Gif String True

An animated thumbnail.

Shares String True

Information about the files that are shared.

PreviewIsTruncated Boolean True

Indicates whether preview is truncated.

Lines Integer True

The total count of lines in the snippet.

LinesMore Integer True

A count of lines not shown in the preview.

UserTeam String True

The URL of a 480x480 thumbnail.

Preview String True

The preview of the file.

PreviewHighlight String True

The preview highlight of the file.

Pseudo-Columns

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

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, or zips. The default value is all.

使用できる値は次のとおりです。all, spaces, snippets, images, gdocs, zips

CData Cloud

MessageReplies

Create, update, delete, and query threads of messages posted to a conversation.

Table Specific Information

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

The MessageReplies table requires ChannelId and ParentMessageId columns in the WHERE clause; otherwise, the driver will automatically add these columns.

  • ChannelId supports the = operator.
  • ParentMessageId supports the = operator.
  • CreatedTime supports the <,>,>=,<=,= operator.
  • ParentCreatedTime supports the <,>,>=,<=,= operator.

For example, the following query is processed server side:

SELECT * FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND ParentMessageId = '1234567890.123456'

Insert

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')

Update

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' 

Delete

MessageReplies can be deleted by providing the ChannelId and the Id of the message.

DELETE FROM MessageReplies WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456 

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Unique identifier for the messages.

ChannelId [KEY] String False

Channels.Id

Conversation ID to fetch thread from.

UserId String True

Users.Id

User Id of the user who posted the reply.

Text String False

Reply message content.

ParentMessageId [KEY] String False

Messages.Id

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.

CreatedTime Datetime True

The created date time of the message reply.

ParentCreatedTime Datetime True

The parent message created date time.

CData Cloud

Messages

Create, update, delete, and query the available messages in Slack.

Table Specific Information

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

  • ChannelId supports the = operator.
  • SearchTerm supports the = operator.
  • CreatedTime supports the <,>,>=,<=,= operator.

Note: The Messages table requires ChannelId or SearchTerm in the WHERE clause. In the case of a simple select, the Slack automatically adds the ChannelId where the current user is a member of the channel to the WHERE clause.

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' 

Insert

Slack allows inserts only when ChannelId and Text are specified.

INSERT INTO Messages (ChannelId, Text) VALUES ('D71R6CSR1', 'This is a message')

Update

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' 

Delete

Messages can be deleted by providing the ChannelId and the Id of the message.

DELETE FROM Messages WHERE ChannelId = 'D71R6CSR1' AND Id = '1234567890.123456' 

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the message.

ChannelId [KEY] String False

Channels.Id

The Id of the channel the message was posted to.

UserId String True

Users.Id

The Id of the user that posted the message.

Text String False

The text of the message.

Type String True

The message type.

Item_type String True

The item type of the message.

Subtype String True

The item subtype of the message.

Team String True

The team of the message.

Pinned_to String False

The pinned details of the message.

Pinned_info_Channel String True

The Id of the pinned channel of the message.

Pinned_info_pinned_by String True

The Id of the pinned by message.

Pinned_info_pinned_ts String True

The Id of the pinned message of the message.

AttachmentsAggregate String True

The attachments made to the message.

Purpose String False

The purpose of the message.

BotId String True

The BotId of the message.

BotLink String True

The BotLink of the message.

Username String True

The UserName of the message.

Reply_count Integer False

The count of the replied channels to the message.

Reply_users_count Integer False

The count of the replied users to the message.

Latest_reply String True

The latest message reply of the message.

Last_read String True

The last read message.

Reply_usersAggreagte String True

The replied user details of the message.

Subscribed Boolean True

The 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.

ItemURL String True

The URL of the item.

Files String True

The files associated with the message.

Blocks String True

The blocks associated with the message.

Reactions String True

The reactions associated with the message.

Upload Boolean True

Indicates whether the file is uploaded.

ClientMsgId String True

The Id of the Client Message.

IsLocked Boolean True

Indicates whether the message is locked.

AppId String True

The App Id of the Slack app.

DisplayAsBot Boolean True

Indicates whether to display the message as a bot.

ParentMessageId String True

The parent message Id.

CData Cloud

Pins

Create, delete, and query all items pinned to a channel.

Select

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'

Insert

INSERTS are allowed when you specify the ChannelId and Id. For example:

INSERT INTO Pins (ChannelId, Id) VALUES ('D71R6CSR1', 'F71R6DRR1')

Update

Slack does not support UPDATE for pins.

Delete

You can delete a pin by providing the ChannelId and Id.

DELETE FROM Pins WHERE ChannelId = 'D71R6CSR1' AND Id = '1505287261.000226'

Columns

Name Type ReadOnly References Description
Id [KEY] String False

The Id of the pinned item.

Type [KEY] String True

The type of the pinned item.

Created Datetime True

A unique datetime representing when the item was pinned.

ChannelId [KEY] String False

Channels.Id

Channel Id to get pinned items for.

PinnedToChannelIds String True

Channels.Id

Comma separated list of channel ids the item is pinned to.

CreatedBy String True

Users.Id

The encoded user id of the user who pinned the item.

CData Cloud

Reactions

Create, delete, and query reactions on items.

Select

The Cloud processes the filters client-side within the Cloud.

SELECT * FROM Reactions 

SELECT * FROM Reactions WHERE Users = 'U046AV8HU3G'

SELECT * FROM Reactions WHERE Team = 'T046W75LRTK' 

SELECT * FROM Reactions WHERE Team = 'T046W75LRTK' AND Users = 'U046AV8HU3G' 

Insert

Inserts are allowed when you specify the ChannelId, Id, and Name. For example:

INSERT INTO Reactions (ChannelId, Id, Name) VALUES ('C04HBS2PS56', '1672114112.994259', 'raised_hands')

Update

Slack does not support UPDATE for reactions.

Delete

You can delete a reaction by providing the ChannelId, Id, and Name.

DELETE FROM Reactions WHERE Name = 'raised_hands' AND ChannelId = 'C04HBS2PS56' AND Id = '1672114112.994259'

Columns

Name Type ReadOnly References Description
Id String False

The Id of the reacted item.

ChannelId String False

Channels.Id

The ChanneldId where item is reacted

Type String True

The type of the reacted item.

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 Team Id of the reaction.

CData Cloud

Reminders

Create, delete, and query all reminders by or for a given user.

Select

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'

Insert

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')

To insert with recurring patterns like "every tuesday" and intervals like "in 15 minutes" use the Frequency column.

INSERT INTO Reminders (Text, Frequency, UserId) VALUES ('Remind me for coffee', 'every tuesday', 'U723764DF')

Update

Slack does not support UPDATE for reminders.

Delete

You can delete a reminder by providing the Id.

DELETE FROM Reminders WHERE Id = 'R71R6CSR1'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the reminder.

Creator String True

Users.Id

The Id of the user who created the reminder.

UserId String False

Users.Id

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. Only non-recurring reminders will return value for this column.

CompleteTimestamp Datetime True

The datetime when the reminder was completed. Only non-recurring reminders will return value for this column.

Frequency String False

Recurring frequency of the reminder. Only recurring reminders will return value for this column. Examples for insert: 'in 15 minutes' or 'every Thursday'.

RecurrenceWeekdays String True

Recurring days for the reminder. Only recurring reminders will return value for this column.

CData Cloud

ScheduledMessages

Query all scheduled messages.

Select

The Cloud will use the Slack API to filter by search criteria that refer to the ChannelId, PostAt and TeamId columns. All columns support server-side processing for the = operator, and the PostAt 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 ScheduledMessages WHERE ChannelId = 'D064Q184VGA'
SELECT * FROM ScheduledMessages WHERE TeamId = 'T01LC4ASB2M'
SELECT * FROM ScheduledMessages WHERE PostAt >= '07-01-2024 00:00:00' and PostAt <= '07-31-2024 00:00:00'

Delete

Scheduled Messages can be deleted by providing the ChannelId and the Id of the scheduled message.

DELETE FROM ScheduledMessages WHERE ChannelId = 'D71R6CSR1' AND Id = 'Q07SJJT75CN' 

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the scheduled message.

ChannelId String True

The Id of the Channel.

PostAt Datetime True

The date the message was posted.

CreatedTime Datetime True

The date the message was created.

Text String True

The text of the scheduled message.

Pseudo-Columns

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

Name Type Description
TeamId String

Team id to list channels in, required if org token is used.

AsUser String

The Id of the user.

CData Cloud

UserGroups

Create, update, and query all User Groups for a Slack team.

Select

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'

Insert

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')

Update

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'

Delete

Slack does not support the deletion of user groups.

Columns

Name Type ReadOnly References 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 of the last update made for the user group.

DateDeleted Datetime True

Datetime that the user group became disabled.

CreatedBy String True

Users.Id

Id of the user who created the user group.

UpdatedBy String True

Users.Id

Id of the user who last modified the user group.

DeletedBy String True

Users.Id

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-Columns

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

Name Type Description
IncludeDisabled Boolean

A boolean set to include or exclude disabled User Groups in the retrieved data.

CData Cloud

UserProfile

Retrieve a user's profile information, including their custom status. This table supports only Select and Update operations.

Select

The Cloud will use the Slack API to process search criteria that refer to the UserId column. This column support server-side processing for the =,IN 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 UserProfile WHERE UserId='W1234567890';
SELECT * FROM UserProfile WHERE UserId in ('W1234567890','W1234567891','W1234567892');

Insert

Slack does not support inserting new users.

Update

There are a number of requirements for updating the user profile:

  • Workspace must be on a paid plan to update the profile value for other users.
  • Must select “API” as the “Data source” within the Configure Profiles admin tool.
  • This operation requires to use a user access token (Not a bot token) that is users.profile:write.
  • Org users cannot change their own profile details.
  • You cannot change the profile details for another user unless you use a token that was generated by an Owner or Admin.
  • You also can only change the profile details for a user if your role level is higher than theirs.

You can update a user profile by providing the Id of the user. For example:

UPDATE UserProfile SET DisplayName = 'Steve', RealName='Steve Smith' , customfields='{"Xf0111111": {"value": "Engineer","alt": ""},"Xf0222222":{"value": "2022-04-11","alt": ""}}', StatusText='riding a train', StatusEmoji=':train:' WHERE userId = 'W1234567890';

Delete

Slack does not support deleting users.

Columns

Name Type ReadOnly References Description
AvatarHash String True

Avatar Hash

DisplayName String False

The display name the user has chosen to identify themselves by in their workspace profile.

DisplayNormalisedName String True

The DisplayName field, but with any non-Latin characters filtered out.

Email String False

The Email of the user. The users:read.email OAuth scope is required to access the email field.

CustomFields String False

All the custom profile fields for the user.

FirstName String False

The user's first name

LastName String False

The user's last name.

Phone String False

The user's phone number, in any format.

ProfileImage1024 String True

URL to square, web-viewable image of a user's profile of size 1024.

ProfileImage192 String True

URL to square, web-viewable image of a user's profile of size 192.

ProfileImage24 String True

URL to square, web-viewable image of a user's profile of size 24.

ProfileImage32 String True

URL to square, web-viewable image of a user's profile of size 32.

ProfileImage48 String True

URL to square, web-viewable image of a user's profile of size 48.

ProfileImage512 String True

URL to square, web-viewable image of a user's profile of size 512.

ProfileImage72 String True

URL to square, web-viewable image of a user's profile of size 72.

ProfileImageOriginal String True

URL to square, web-viewable image of a user's profile of original size.

IsCustomImage Boolean True

Whether the image of a user's profile is custom image or not.

Pronouns String False

The pronouns the user prefers to be addressed by.

HuddleState String True

Huddle state of the user.

HuddleStateCallId String True

Call Id of the huddle state

HuddleStateExpirationTime Datetime True

The timestamp of when the huddle state will expire.

RealName String False

The user's first and last name.

RealNormalisedName String True

The RealName field, but with any non-Latin characters filtered out.

Skype String True

A shadow from a bygone era. It will always be an empty string and cannot be set otherwise.

StartDate String False

The date the person joined the organization.

StatusEmoji String False

The displayed emoji that is enabled for the Slack team, such as :train:.

StatusEmojiDisplayInfo String True

The information about the status emoji display.

StatusExpireTime Datetime False

The timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire.

StatusText String False

The displayed text of up to 100 characters.

StatusTextCanonical String False

The Status text of the user.

Title String False

The user's title.

Pseudo-Columns

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

Name Type Description
UserId String

User Id to retrieve profile info for.

IncludeLabels String

Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended. Default value is False

CData Cloud

Users

Update and query all users for a Slack team.

Select

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'

Insert

Slack does not support inserting new users.

Update

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'

Delete

Slack does not support deleting users.

Columns

Name Type ReadOnly References 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.

CData Cloud

ビュー

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

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

CData Cloud - Slack ビュー

Name Description
Dnd Retrieves a user's current Do Not Disturb status.
Team Retrieves information about the current team.
TeamAccessLogs Gets the access logs for the current team.
TeamInfo Retrieves the Do Not Disturb status for up to 50 users on a team.
TeamProfileFields Retrieves a team profile's Fields
TeamProfileSections Retrieves a team profile's Sections
UsersPresence Query user's presence information. Defaults to the authed user.

CData Cloud

Dnd

Retrieves a user's current Do Not Disturb status.

Select

The Cloud processes filters client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM Dnd

Columns

Name Type References Description
DndEnabled Boolean The DND status of the user.
NextDndEndTs Datetime The timestamp when the upcoming DND session ends.
NextDndStartTs Datetime The timestamp when the upcoming DND session starts.
SnoozeEnabled Boolean The snooze status of the user. Visible only if the user is the current user.
SnoozeEndtime Datetime The time when snooze ends. Visible only if the user is the current user.
SnoozeIsIndefinite Boolean Indicates snooze does not end automatically. Visible only if the user is the current user.
SnoozeRemaining Datetime The time remaining until snooze ends. Visible only if the user is the current user.

CData Cloud

Team

Retrieves information about the current team.

Select

The Cloud uses the Slack API to filter by search criteria that refer to the Id column. The column supports server-side processing for the = operator.

The Cloud processes filters client-side within the Cloud.

For example, the following queries are processed server-side:

SELECT * FROM Team

SELECT * FROM Team WHERE Id = 'T01LC4ASB2M'

Columns

Name Type References Description
Domain String The domain of the team.
EmailDomain String The email of the domain of the team.
Id [KEY] String The Id of the team.
Name String The name of the team.
EnterpriseId String The Enterprise Id of the team.
EnterpriseName String The Enterprise Name of the team.
Icon String The Icon of the team.
IsVerified Boolean Indicates whether the team is verified.
LobSalesHomeEnabled Boolean Indicates the Sales Home status.
Url String The URL of the team.
AvatarBaseUrl String The Avatar base URL of the team.

CData Cloud

TeamAccessLogs

Gets the access logs for the current team.

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

The TeamAccessLogs table requires TeamId column in the WHERE clause; otherwise, the driver will automatically add the column.

  • TeamId supports the = operator.
For example, the following query is processed server side:
SELECT * FROM TeamAccessLogs WHERE TeamId = 'T01LC4ASB3M'

Columns

Name Type References Description
TeamId [KEY] String The Id of the team.
UserId String The Id of the user who accessed Slack.
Username String The username of the user who accessed Slack.
DateFirst Datetime The first login date time.
DateLast Datetime The last login date time.
Count Integer The login count.
IP String The IP address of the user.
UserAgent String The user agent with which the user logged in.
Isp String The internet service provider.
Country String The country where the access originated.
Region String The region where the access originated.

CData Cloud

TeamInfo

Retrieves the Do Not Disturb status for up to 50 users on a team.

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

The TeamInfo table requires the User column in the WHERE clause; otherwise, the driver automatically adds the column.

  • User supports the =,IN operator.
For example, the following query is processed server side:
SELECT * FROM TeamInfo WHERE User = 'U01KZFNNTPC'

SELECT * FROM TeamInfo WHERE User IN ('U01KZFNNTPC','U04QTH44D9S')

Columns

Name Type References Description
User String The Id of the user.
DndEnabled Boolean Indicates whether DND is enabled.
NextDndStartTime Datetime The next DND Start time.
NextDndEndTime Datetime The next DND End time.

CData Cloud

TeamProfileFields

Retrieves a team profile's Fields

Select

The Cloud uses the Slack API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the Cloud.

  • IsHidden supports the = operator.
For example, the following query is processed server side:
SELECT * FROM TeamProfileFields

SELECT * FROM TeamProfileFields WHERE IsHidden = false

Columns

Name Type References Description
Id [KEY] String The Id of the field.
Ordering Integer The placement of the field on the profile.
Label String The text that will appear under the field.
Hint String Any additional context the user may need to understand the field.
Type String The format the field supports. Can be date, link, long_text, options_list, tags, text, or user.
PossibleValues String The values that allowed to be chosen by the user.
OptionsIsScim Boolean If true, can be updated via SCIM APIs.
OptionsIsProtected Boolean
IsHidden Boolean Indicates whether the field is hidden or not.
SectionId String The id of the section the field is in.

CData Cloud

TeamProfileSections

Retrieves a team profile's Sections

Select

The Cloud processes filters client-side within the Cloud.

For example, the following query is processed server side:

SELECT * FROM TeamProfileSections

Columns

Name Type References Description
Id [KEY] String The Id of the section.
TeamId String The Id of the Team.
Order Integer The placement of the section on the profile.
Label String The text that will appear under the section.
SectionType String The type of content in the section. Users can only create custom section types.
IsHidden Boolean Indicates whether the section is hidden or not.

CData Cloud

UsersPresence

Query user's presence information. Defaults to the authed user.

Select

You must specify the UserId column in the WHERE clause to query the UsersPresence view. If not specified, the presence information will be fetched for the authed user.

The Cloud uses the Slack API to process search criteria that refer to the UserId 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 UsersPresence WHERE UserId = 'U03AZBU3CMT'
SELECT * FROM UsersPresence WHERE UserId IN ('U03AZBU3CMT',  'U03AZBU3CZH')

Columns

Name Type References Description
UserId [KEY] String The Id of the User.
Presence String User's current presence (either active or away).
Online Boolean User's online status.
AutoAway Boolean User status is away automatically.
ManualAway Boolean User status is away manually.
ConnectionCount Integer The connection count.
LastActivity Datetime Last activity of the user.

CData Cloud

ストアドプロシージャ

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

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

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

Name Description
AddProfilePhoto Set the authenticated user's profile photo. Supported formats for Profile photo are jpeg, gif and png.
CloseChannel Closes a direct message or multiperson direct message.
DisableUserGroup Disable an existing User Group.
EnableUserGroup Enable a User Group.
EndCall Ends a Call.
EndDnd Ends the current user's Do Not Disturb session immediately.
EndSnooze Ends the current user's snooze mode immediately.
GetPermaLink Retrieve a permalink URL for a specific extant message.
GetTeamBillableInfo Reads a workspace's billing plan information.
InviteUser Invites users to a channel.
JoinChannel Joins an existing conversation.
JoinMultipleChannels Joins the existing muliple channels.
LeaveChannel Leaves a conversation.
OpenChannel Opens or resumes a direct message or multiperson direct message.
RemoveProfilePhoto Deletes the authenticated user's profile photo.
SendEphemeralMessage Sends an ephemeral message to a user in a channel.
SendScheduleMessage Schedules a message to be sent to a channel.
SetReadCursor Sets the read cursor in a channel.
SetSnooze Turns on Do Not Disturb mode for the current user, or changes its duration.
ShareMeMessage Share a me message into a channel.

CData Cloud

AddProfilePhoto

Set the authenticated user's profile photo. Supported formats for Profile photo are jpeg, gif and png.

Input

Name Type Description
FilePath String The full path to the image file to upload.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

CloseChannel

Closes a direct message or multiperson direct message.

Input

Name Type Description
ChannelId String Id of the conversation to close.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

DisableUserGroup

Disable an existing User Group.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is usergroups:write. For example:

EXECUTE DisableUserGroup UserGroup = 'S0604QSJC', IncludeCount = true

Input

Name Type Description
UserGroup String The ID of the User Group to disable.
IncludeCount String Boolean value that represents whether to include the number of users in the User Group.
TeamId String Target team id where the user group is, required if org token is used.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

EnableUserGroup

Enable a User Group.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is usergroups:write. For example:

EXECUTE EnableUserGroup UserGroup = 'S0604QSJC', IncludeCount = true

Input

Name Type Description
UserGroup String The ID of the User Group to enable.
IncludeCount String Boolean value that represents whether to include the number of users in the User Group.
TeamId String Team id where the user group is, required if org token is used.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

EndCall

Ends a Call.

Input

Name Type Description
CallId String The Id returned when registering the call.
Duration String Call duration in seconds.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

EndDnd

Ends the current user's Do Not Disturb session immediately.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

EndSnooze

Ends the current user's snooze mode immediately.

Result Set Columns

Name Type Description
Success String The result of the procedure.
DndEnabled String Indicates whether DND is enabled.
NextDndStartTime Datetime The next DND Start Time.
NextDndEndTime Datetime The next DND End Time.
SnoozeEnabled String Indicates whether snooze is enabled.

CData Cloud

GetPermaLink

Retrieve a permalink URL for a specific extant message.

Input

Name Type Description
ChannelId String The Id of the conversation or channel containing the message.
MessageId String A message's timestamp (ts) value, uniquely identifying it within a channel.

Result Set Columns

Name Type Description
Success String The result of the procedure.
ChannelId String The Id of the Channel.
PermaLink String The PermaLink URL of the message.

CData Cloud

GetTeamBillableInfo

Reads a workspace's billing plan information.

Result Set Columns

Name Type Description
Success String The result of the procedure.
Plan String The workspace's billing plan.

CData Cloud

InviteUser

Invites users to a channel.

Input

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 1000 users may be listed.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

JoinChannel

Joins an existing conversation.

Input

Name Type Description
ChannelId String The Id of the channel to join.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

JoinMultipleChannels

Joins the existing muliple channels.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. For example:

EXECUTE JoinMultipleChannels

You can also specify the comma-separated names of the channels to join. For example:

EXECUTE JoinMultipleChannels Channels = 'test*, *Slack*'

Input

Name Type Description
Channels String The comma-separated names of the channels to join. If not provided, by default, the user will join all the channels in which he has not yet joined.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

LeaveChannel

Leaves a conversation.

Input

Name Type Description
ChannelId String Id of the conversation to leave.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

OpenChannel

Opens or resumes a direct message or multiperson direct message.

Input

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.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

RemoveProfilePhoto

Deletes the authenticated user's profile photo.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

SendEphemeralMessage

Sends an ephemeral message to a user in a channel.

Stored Procedure Specific Information

Slack allows only a small subset of columns to be used in the Exec query. These columns can typically be used with only = comparison. The required scopes to execute this SP is chat:write, chat:write:user and chat:write:bot. For example:

EXECUTE SendEphemeralMessage ChannelId = 'C01KWCPJJ68', UserId = 'U063F52GHED', Text = 'test message'

Input

Name Type Description
ChannelId String The Id of the conversation or channel containing the message.
UserId String The Id of the user who will receive the ephemeral message.
Text String The message that you want to send.
Attachments String A JSON-based array of structured attachments, presented as a URL-encoded string.
Blocks String A JSON-based array of structured blocks, presented as a URL-encoded string.
AsUser Boolean Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps.
IconEmoji String The emoji to use as the icon from this message. This overrides IconUrl.
IconUrl String The URL to an image to use as the icon for this message.
LinkNames Boolean Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
Parse String Change how messages are treated. Value should be either none or full.

使用できる値は次のとおりです。none, full

ParentMessageId String Provide another message's Id value to make this message a reply. Avoid using a reply's Id value; use its parent instead.
Username String The username of your bot.

Result Set Columns

Name Type Description
Success String The result of the procedure.
MessageId String The Id of the message sent.

CData Cloud

SendScheduleMessage

Schedules a message to be sent to a channel.

Stored Procedure Specific Information

Slack allows only a subset of columns to be used in the Exec query. These columns can typically be used with the = comparison. The required scopes to execute this SP are chat:write, chat:write:user and chat:write:bot. For example:

EXECUTE SendScheduleMessage Channel = 'D064Q184VGA', PostAt = '2024-07-27 08:20:27.0', Text = 'test message', ReplyBroadCast = true

Input

Name Type Description
Channel String Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.
PostAt Datetime The datetime representing the future time the message should post to Slack.
Text String The message that you want to send.
Attachments String A JSON-based array of structured attachments, presented as a URL-encoded string.
Blocks String A JSON-based array of structured blocks, presented as a URL-encoded string.
AsUser Boolean Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps.
LinkNames Boolean Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
Metadata String JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.
Parse String Change how messages are treated. Value should be one of none or full.

使用できる値は次のとおりです。none, full

ReplyBroadCast Boolean Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
ParentMessageId String Provide another message's id value to make this message a reply. Avoid using a reply's id value; use its parent instead.
UnfurlLinks Boolean Pass true to enable unfurling of primarily text-based content.
UnfurlMedia Boolean Pass false to disable unfurling of media content.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

SetReadCursor

Sets the read cursor in a channel.

Input

Name Type Description
ChannelId String Channel or conversation to set the read cursor for.
MessageId String Unique identifier of message you want marked as most recently seen in this conversation.

Result Set Columns

Name Type Description
Success String The result of the procedure.

CData Cloud

SetSnooze

Turns on Do Not Disturb mode for the current user, or changes its duration.

Input

Name Type Description
NumOfMinutes String The number of minutes to snooze, starting now.

Result Set Columns

Name Type Description
Success String The result of the procedure.
SnoozeEnabled String Status whether snooze is enabled or not.
SnoozeEndTime Datetime The snooze End Time.
SnoozeRemaining String The remaining time of snooze, expressed in seconds.
SnoozeIsIndefinite String Indicates whether snooze is indefinite.

CData Cloud

ShareMeMessage

Share a me message into a channel.

Input

Name Type Description
Channel String Channel to send message to. Can be a public channel, private group or IM channel. This value can be an encoded ID or a name.
Text String Text of the message to send.

Result Set Columns

Name Type Description
Success String The result of the procedure.
ChannelId String Id of the Channel.
MessageId String Id of the Message

CData Cloud

システムテーブル

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

スキーマテーブル

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

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

データソーステーブル

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

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

クエリ情報テーブル

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

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

CData Cloud

sys_catalogs

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

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

SELECT * FROM sys_catalogs

Columns

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

CData Cloud

sys_schemas

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

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

          SELECT * FROM sys_schemas
          

Columns

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

CData Cloud

sys_tables

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

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

          SELECT * FROM sys_tables
          

Columns

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

CData Cloud

sys_tablecolumns

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

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

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

Columns

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

CData Cloud

sys_procedures

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

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

          SELECT * FROM sys_procedures
          

Columns

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

CData Cloud

sys_procedureparameters

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

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

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

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

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

Columns

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

Pseudo-Columns

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

CData Cloud

sys_keycolumns

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

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

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

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

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

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

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

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

         SELECT * FROM sys_primarykeys
          

Columns

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

CData Cloud

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

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

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

データソースのSELECT 機能

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

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

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

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

Columns

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

CData Cloud

sys_identity

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

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

         SELECT * FROM sys_identity
          

Columns

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

CData Cloud

sys_information

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

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

SELECT * FROM sys_information

Columns

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

CData Cloud

接続文字列オプション

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

Authentication


プロパティ説明
AuthSchemeThe scheme used for authentication. Accepted entries are OAuth and UserToken.
OAuthVersionThe type of authentication to use when connecting to Slack.
UserTokenSet this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.
TokenSet to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

SSL


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

Logging


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

Schema


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

Miscellaneous


プロパティ説明
ChannelTypeThe types of Channel to be returned when connecting to Slack.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
TeamThe name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseSearchSearch Endpoint will be used for fetching the Channels.
CData Cloud

Authentication

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


プロパティ説明
AuthSchemeThe scheme used for authentication. Accepted entries are OAuth and UserToken.
OAuthVersionThe type of authentication to use when connecting to Slack.
UserTokenSet this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.
TokenSet to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token
CData Cloud

AuthScheme

The scheme used for authentication. Accepted entries are OAuth and UserToken.

Possible Values

OAuth, UserToken, Token

データ型

string

デフォルト値

"OAuth"

解説

Use the following options to select your authentication scheme:

  • OAuth: Set to this to perform OAuth authentication.
  • UserToken: Set to this to perform UserToken authentication.
  • Token: Set to this to perform Token authentication.

CData Cloud

OAuthVersion

The type of authentication to use when connecting to Slack.

Possible Values

v2, openid

データ型

string

デフォルト値

"v2"

解説

  • v2: Set to this to perform OAuth authentication on new applications.
  • openid: Set to this to perform OAuth authentication using OpenId Connect.

CData Cloud

UserToken

Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.

データ型

string

デフォルト値

""

解説

Set this to use the non-expiring user token created in Slack. Other types of token are also accepted. DEPRECATED: Use the Token Auth Scheme instead.

CData Cloud

Token

Set to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token

データ型

string

デフォルト値

""

解説

Set to this to perform Token authentication. Different token Types that are supported are as follows: Bot token, Workflow token, User token, Configuration token, App-level token, and Service token

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

Scope

データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

データ型

string

デフォルト値

""

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

CData Cloud

SSL

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


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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

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

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

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

CData Cloud

Logging

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


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

Verbosity

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

データ型

string

デフォルト値

"1"

解説

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

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

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

CData Cloud

Schema

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


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

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Miscellaneous

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


プロパティ説明
ChannelTypeThe types of Channel to be returned when connecting to Slack.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
TeamThe name of the Slack Team. If you omit the optional Team parameter, you will be allowed to choose which workspace they are authenticating against.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseSearchSearch Endpoint will be used for fetching the Channels.
CData Cloud

ChannelType

The types of Channel to be returned when connecting to Slack.

Possible Values

all, public, private, im, mpim

データ型

string

デフォルト値

"all"

解説

  • all: Set to this to retrieve all the channels.
  • public: Set to this to retrieve public channels.
  • private: Set to this to retrieve Private channels.
  • im: Set to this to retrieve Direct Message channels.
  • mpim: Set to this to retrieve MultipartyDirectMessage channels.

CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

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

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

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

CData Cloud

PseudoColumns

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

データ型

string

デフォルト値

""

解説

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

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

Table1=Column1;Table1=Column2;Table2=Column3

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

*=*

CData Cloud

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.

データ型

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.

CData Cloud

Timeout

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

データ型

int

デフォルト値

60

解説

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

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

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

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

CData Cloud

UseSearch

Search Endpoint will be used for fetching the Channels.

データ型

bool

デフォルト値

false

解説

Search Endpoint will be used for fetching the Channels.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434