製品情報をご覧ください

製品情報や無償評価版を製品ページにてご確認いただけます。

製品ページへ

SQLAlchemy ORM を使って、Python でBasecamp データに連携

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

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムBasecamp data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Basecamp に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Basecamp 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

Basecamp Data への接続

Basecamp data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Basecamp はBasic 認証もしくはOAuth 2.0 認証を使います。Basic 認証を使用するには、Basecamp へのログインに使用するuser およびpassword が必要です。OAuth 2.0 を使用して認証するには、Basecamp にアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。

詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。

さらに、AccountId 接続プロパティを設定する必要があります。これはBasecamp にログイン後にURL で確認できます。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからBasecamp に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でBasecamp Data をモデル化します

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

engine = create_engine("basecamp///?User=test@northwind.db&Password=test123")

Basecamp Data のマッピングクラスの宣言

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

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

Basecamp Data をクエリ

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

query メソッドを使う

engine = create_engine("basecamp///?User=test@northwind.db&Password=test123")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Projects).filter_by(Drafts="True"):
	print("Name: ", instance.Name)
	print("DocumentsCount: ", instance.DocumentsCount)
	print("---------")

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

execute メソッドを使う

Projects_table = Projects.metadata.tables["Projects"]
for instance in session.execute(Projects_table.select().where(Projects_table.c.Drafts == "True")):
	print("Name: ", instance.Name)
	print("DocumentsCount: ", instance.DocumentsCount)
	print("---------")

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

Basecamp Data の挿入(INSERT)

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

new_rec = Projects(Name="placeholder", Drafts="True")
session.add(new_rec)
session.commit()

Basecamp Data を更新(UPDATE)

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

updated_rec = session.query(Projects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Drafts = "True"
session.commit()

Basecamp Data を削除(DELETE)

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

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

製品の無償トライアル情報

Basecamp Python Connector の30日の無償トライアル をぜひダウンロードして、Basecamp data への接続をPython アプリやスクリプトから簡単に作成しましょう。

 
 
ダウンロード