SQLAlchemy ORM を使って、Python でSlack のデータに連携する方法

CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でSlack にOR マッピング可能に。

加藤龍彦
デジタルマーケティング

最終更新日:2023-09-23

この記事で実現できるSlack 連携のシナリオ

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Slack は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Slack にデータ連携するPython アプリケーションを構築し、Slack のデータを可視化できます。 本記事では、SQLAlchemy でSlack に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

  1. Slack をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
  2. Python をはじめとする多様なデータ分析・BI ツールにSlack のデータを連携
  3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSlack の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします:

pip install sqlalchemy

モジュールのインポートを忘れずに行います:

import sqlalchemy

Python でSlack のデータをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Slack のデータに連携するEngne を作成します。

engine = create_engine("slack///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

接続情報の取得

Slack はOAuth 認証標準を利用しています。OAuth を使って認証するには、Slack 側でアプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得してください。 認証方法については、ヘルプドキュメントの「Slack への接続」を参照してください。

Slack のデータのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Channels テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。

base = declarative_base()
class Channels(base):
	__tablename__ = "Channels"
	Id = Column(String,primary_key=True)
	Name = Column(String)
	...

Slack のデータをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("slack///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Channels).filter_by(IsPublic="True"):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Channels_table = Channels.metadata.tables["Channels"]
for instance in session.execute(Channels_table.select().where(Channels_table.c.IsPublic == "True")):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Slack のデータの挿入(INSERT)

Slack のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Slack にすべての追加インスタンスを送ります。

new_rec = Channels(Id="placeholder", IsPublic="True")
session.add(new_rec)
session.commit()

Slack のデータを更新(UPDATE)

Slack のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Slack にレコードを追加します。

updated_rec = session.query(Channels).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.IsPublic = "True"
session.commit()

Slack のデータを削除(DELETE)

Slack のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Channels).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Slack からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。