製品情報をご覧ください

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

製品ページへ

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

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

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

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

SurveyMonkey Data への接続

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

SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。

SurveyMonkey への接続に使用できる認証方法は2つあります。

  • プライベートoauth アプリケーションを登録するときに、個人用アクセストークンを使用します。
  • パブリックoauth アプリケーションを登録するときに、OAuth を使用します。

個人用アクセストークンの使用

個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、Creating a Custom OAuth App の手順に従って、次の接続プロパティを設定します。

  • OAuthAccessToken:アプリケーション設定で生成されたAccessToken に設定。
  • InitiateOAuth:OFF に設定。

OAuth の使用

本製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的にEmbedded Credentials を使用して接続します。

独自のカスタムOAuth アプリを使用したい場合は、Custom Credentials を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

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

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

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

base = declarative_base()
class MySurvey_Responses(base):
	__tablename__ = "MySurvey_Responses"
	RespondentId = Column(String,primary_key=True)
	ChoiceId = Column(String)
	...

SurveyMonkey Data をクエリ

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

query メソッドを使う

engine = create_engine("surveymonkey///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:portNumber&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(MySurvey_Responses).filter_by(ChoiceText="blue"):
	print("RespondentId: ", instance.RespondentId)
	print("ChoiceId: ", instance.ChoiceId)
	print("---------")

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

execute メソッドを使う

MySurvey_Responses_table = MySurvey_Responses.metadata.tables["MySurvey_Responses"]
for instance in session.execute(MySurvey_Responses_table.select().where(MySurvey_Responses_table.c.ChoiceText == "blue")):
	print("RespondentId: ", instance.RespondentId)
	print("ChoiceId: ", instance.ChoiceId)
	print("---------")

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

SurveyMonkey Data の挿入(INSERT)

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

new_rec = MySurvey_Responses(RespondentId="placeholder", ChoiceText="blue")
session.add(new_rec)
session.commit()

SurveyMonkey Data を更新(UPDATE)

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

updated_rec = session.query(MySurvey_Responses).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ChoiceText = "blue"
session.commit()

SurveyMonkey Data を削除(DELETE)

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

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

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

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

 
 
ダウンロード