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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でDynamics NAV データをモデル化

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

engine = create_engine("dynamicsnav///?http://myserver:7048&User=myserver\Administrator&Password=admin&ServerInstance=DYNAMICSNAV71")

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

Dynamics NAV に接続する前に、サーバーでOData サービスを有効にしておく必要があります。OData サービスを有効にすると、CData 製品はサーバーで発行されるあらゆるサービスにクエリできるようになります。Url を有効なDynamics NAV サーバー組織のルート（例：http://MyServer:7048）およびServerInstance（例：DynamicsNAV71）に設定します。 もしサーバーにService Default Company がない場合は、Company（例：'CRONUS Canada, Inc.'）も設定する必要があります。 マルチテナントインストールでは、Tenant にテナントId（例：'Cronus1'）を指定します。

認証するには、User およびPassword プロパティを設定して、Dynamics NAV ログインクレデンシャルまたはWindows ユーザークレデンシャルを有効にします。 AuthScheme で適切な認証メソッドを選択します。

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

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

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

Dynamics NAV データをクエリ

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

query メソッドを使う

engine = create_engine("dynamicsnav///?http://myserver:7048&User=myserver\Administrator&Password=admin&ServerInstance=DYNAMICSNAV71")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customer).filter_by(Name="Bob"):
	print("Name: ", instance.Name)
	print("Prices_Including_VAT: ", instance.Prices_Including_VAT)
	print("---------")

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

execute メソッドを使う

Customer_table = Customer.metadata.tables["Customer"]
for instance in session.execute(Customer_table.select().where(Customer_table.c.Name == "Bob")):
	print("Name: ", instance.Name)
	print("Prices_Including_VAT: ", instance.Prices_Including_VAT)
	print("---------")

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

Dynamics NAV データの挿入（INSERT）

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

new_rec = Customer(Name="placeholder", Name="Bob")
session.add(new_rec)
session.commit()

Dynamics NAV データを更新（UPDATE）

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

updated_rec = session.query(Customer).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "Bob"
session.commit()

Dynamics NAV データを削除（DELETE）

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

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

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

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

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