SQLAlchemy ORM を使用して Python で SharePoint のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for SharePoint と SQLAlchemy ツールキットを使用して、SharePoint に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して SharePoint のデータ に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの SharePoint のデータ を操作する際に比類のないパフォーマンスを提供します。SharePoint に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 SharePoint にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

はじめに

---

SharePoint のデータ への接続

SharePoint のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

Microsoft SharePoint への接続

URL の設定：

Microsoft SharePoint では、2つの範囲でデータを操作できます。グローバルなMicrosoft SharePoint サイト全体を対象にするか、個々のサイトのみを対象にするかを選択できます。

グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作したい場合は、URL 接続プロパティをサイトコレクションURL に設定しましょう。以下のような形式です。

https://teams.contoso.com

個々のサイトのリストおよびドキュメントのみを扱いたい場合は、URL 接続プロパティを個々のサイトURL に設定してください。以下のような形式です。

https://teams.contoso.com/TeamA

続いて、お使いの環境に適した認証プロパティを設定していきましょう。詳細な設定手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご参照ください。

Microsoft SharePoint Online

SharePointEdition を"SharePoint Online" に設定し、User およびPassword にはSharePoint へのログオンで使用するクレデンシャル（例：Microsoft Online Services アカウントのクレデンシャル）を設定します。

Microsoft SharePoint Online は様々なクラウドベースアーキテクチャをサポートしており、それぞれ異なる認証スキームが利用できます。

• Microsoft Entra ID（Azure AD）
• ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン（SSO）
• Azure MSI
• Azure パスワード
• OAuthJWT
• SharePointOAuth

Microsoft SharePoint オンプレミス

Microsoft SharePoint オンプレミスでは、多くのオンプレミス環境に対応した認証方式をサポートしています。

• Windows（NTLM）
• Kerberos
• ADFS
• 匿名アクセス

まずSharePointEdition を"SharePoint On-Premises" に設定しましょう。

Windows（NTLM）認証

これは最も一般的な認証方式です。そのため、CData 製品ではNTLM をデフォルトとして使用するよう事前設定されています。Windows のUser およびPassword を設定するだけで接続できます。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて SharePoint にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での SharePoint のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、SharePoint のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("sharepoint:///?User=myuseraccount&Password=mypassword&Auth Scheme=NTLM&URL=http://sharepointserver/mysite&SharePointEdition=SharePointOnPremise")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、MyCustomList テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

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

SharePoint のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("sharepoint:///?User=myuseraccount&Password=mypassword&Auth Scheme=NTLM&URL=http://sharepointserver/mysite&SharePointEdition=SharePointOnPremise")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(MyCustomList).filter_by(Location="Chapel Hill"):
	print("Name: ", instance.Name)
	print("Revenue: ", instance.Revenue)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

MyCustomList_table = MyCustomList.metadata.tables["MyCustomList"]
for instance in session.execute(MyCustomList_table.select().where(MyCustomList_table.c.Location == "Chapel Hill")):
	print("Name: ", instance.Name)
	print("Revenue: ", instance.Revenue)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

SharePoint のデータ の挿入

SharePoint のデータ を挿入するには、マッピングクラスのインスタンスを定義し、アクティブな session に追加します。セッションの commit 関数を呼び出して、追加されたすべてのインスタンスを SharePoint にプッシュします。

new_rec = MyCustomList(Name="placeholder", Location="Chapel Hill")
session.add(new_rec)
session.commit()

SharePoint のデータ の更新

SharePoint のデータ を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを SharePoint にプッシュします。

updated_rec = session.query(MyCustomList).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Location = "Chapel Hill"
session.commit()

SharePoint のデータ の削除

SharePoint のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

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

無料トライアルと詳細情報

CData Python Connector for SharePoint の30日間の無料トライアルをダウンロードして、SharePoint のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。