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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でActive Directory データをモデル化

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

engine = create_engine("activedirectory///?User=cn=Bob F,ou=Employees,dc=Domain&Password=bob123&Server=10.0.1.2&Port=389")

ActiveDirectory 接続プロパティの取得・設定方法

接続には以下の情報が必要です。

• 有効なユーザーおよびパスワード情報 (例：Domain\BobF or cn=Bob F,ou=Employees,dc=Domain)。
• 接続するサーバーのIP、ホスト名、ポートを含むサーバー情報。

• BaseDN: 指定されたname にLDAP 検索の範囲を制限します。

  ちなみに、BaseDN を狭い範囲に設定することで大幅にパフォーマンスを改善できます。例えば、cn=users,dc=domain は、cn=users およびその子の範囲に戻り値の結果を制限します。

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

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

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

Active Directory データをクエリ

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

query メソッドを使う

engine = create_engine("activedirectory///?User=cn=Bob F,ou=Employees,dc=Domain&Password=bob123&Server=10.0.1.2&Port=389")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(User).filter_by(CN="Administrator"):
	print("Id: ", instance.Id)
	print("LogonCount: ", instance.LogonCount)
	print("---------")

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

execute メソッドを使う

User_table = User.metadata.tables["User"]
for instance in session.execute(User_table.select().where(User_table.c.CN == "Administrator")):
	print("Id: ", instance.Id)
	print("LogonCount: ", instance.LogonCount)
	print("---------")

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

Active Directory データの挿入（INSERT）

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

new_rec = User(Id="placeholder", CN="Administrator")
session.add(new_rec)
session.commit()

Active Directory データを更新（UPDATE）

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

updated_rec = session.query(User).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CN = "Administrator"
session.commit()

Active Directory データを削除（DELETE）

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

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

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

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

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