2010年8月13日金曜日

LINQ to SQL備忘録

Entity オブジェクトのトラッキングに関する状態に関しては、次のリンクが参考になります。
オブジェクトの状態と変更の追跡 (LINQ to SQL)
http://msdn.microsoft.com/ja-jp/library/bb386982.aspx

動作確認環境は次の通りです。

  • 実行OS: Windows Vista Enterprise
  • 開発環境 : Visual Studio 2008 Professional
  • .NET 3.5
  • 使用データベース: AdventureWorks

1. 使用する Entity クラスと AdventureWorksDataContext の定義

DataContext に対する処理を簡単にするために、DataContext を継承して、AdventureWorksDataContext というクラスを作成します。Entity クラスとして SalesReason, SalesOrder, Customer を定義しています。今回のサンプルで主に使用するのは SalesReason クラスです。

  1. namespace LINQ2SQL.Entity
  2. {
  3. ///
  4. /// AdventureWorks用のDataContextクラスの作成
  5. ///
  6. public class AdventureWorksDataContext : DataContext
  7. {
  8. public AdventureWorksDataContext(string fileOrServerOrConnection)
  9. : base(fileOrServerOrConnection) { }
  10. public AdventureWorksDataContext(IDbConnection connection)
  11. : base(connection) { }
  12. public AdventureWorksDataContext(string fileOrServerOrConnection, MappingSource mapping)
  13. : base(fileOrServerOrConnection, mapping) { }
  14. public AdventureWorksDataContext(IDbConnection connection, MappingSource mapping)
  15. : base(connection, mapping) { }

  17. ///
  18. /// エンティティの定義
  19. /// 初期時にベースクラス内でリフレクションを介して
  20. /// 初期化される。
  21. ///
  22. public Table SalesOrders;
  23. public Table Customers;
  24. public Table SalesReasons;

  26. }
  27. ///
  28. /// TableアトリビュートにはSystem.Data.Linqへの参照が必要
  29. ///
  30. [Table(Name = "Sales.SalesOrderHeader")]
  31. public class SalesOrder
  32. {
  33. [Column(IsPrimaryKey = true)]
  34. public int SalesOrderID;
  35. [Column]
  36. public DateTime OrderDate;
  37. [Column]
  38. public DateTime DueDate;
  39. [Column(CanBeNull = true)]
  40. public DateTime? ShipDate;
  41. [Column]
  42. public decimal SubTotal;
  43. [Column]
  44. public decimal TotalDue;

  46. [Column]
  47. public int CustomerID;
  48. private EntityRef _customer;
  49. [Association(Storage = "_customer", ThisKey = "CustomerID", IsForeignKey = true)]
  50. public Customer Customer
  51. {
  52. get { return _customer.Entity; }
  53. set { _customer.Entity = value; }
  54. }

  56. }
  57. [Table(Name = "Person.Contact")]
  58. public class Customer
  59. {
  60. public Customer()
  61. {
  62. _salesOrders = new EntitySet();
  63. }
  64. [Column(Name = "ContactID", IsPrimaryKey = true, IsDbGenerated = true)]
  65. public int CustomerID;
  66. [Column]
  67. public string FirstName;
  68. [Column]
  69. public string LastName;
  70. private EntitySet _salesOrders;
  71. [Association(OtherKey = "CustomerID", Storage = "_salesOrders")]
  72. public EntitySet SalesOrders
  73. {
  74. get { return _salesOrders; }
  75. set { _salesOrders.Assign(value); }
  76. }
  77. }
  78. [Table(Name="Sales.SalesReason")]
  79. public class SalesReason
  80. {
  81. public SalesReason() { }
  82. private int _salesReasonID = 0;
  83. [Column(Name="SalesReasonID", Storage="_salesReasonID",IsPrimaryKey=true, IsDbGenerated=true)]
  84. public int SalesReasonID
  85. {
  86. get { return _salesReasonID; }
  87. set { _salesReasonID = value; }
  88. }
  89. private string _name;
  90. [Column(Name="Name", Storage="_name")]
  91. public string Name
  92. {
  93. get { return _name; }
  94. set { _name = value; }
  95. }
  96. private string _reasonType;
  97. [Column(Name = "ReasonType", Storage = "_reasonType")]
  98. public string ReasonType
  99. {
  100. get { return _reasonType; }
  101. set { _reasonType = value; }
  102. }
  103. private DateTime _modifiedDate;
  104. [Column(Name = "ModifiedDate", Storage = "_modifiedDate", IsVersion=true )]
  105. public DateTime ModifiedDate
  106. {
  107. get { return _modifiedDate; }
  108. set { _modifiedDate = value; }
  109. }
  110. }
  111. }

前述したとおり、今回は SalesReason クラスを使用して、SalesReason テーブルにデータの登録、更新、削除を行ってみます。

2. Entity クラスの新規作成、更新、削除

LINQ to SQL では変更の反映は、 DataContext.SubmitChanges() メソッドを呼び出すことで行います。 SubmitChangtes() を呼び出すと、トラッキングサービスにより管理されていた Entity オブジェクトの更新、削除、新規作成処理がまとめて処理されデータベースのテーブルにクエリが発行されます。トラッキングサービスによって認識されている変更された Entity オブジェクトは DataContext.ChangeSet() メソッドを使用することにより、変更、削除、挿入対象の Entity オブジェクトを取得できます。 取得されたオブジェクトの変更内容が SubmitChanges を呼び出したときにデータベースにすべて反映されます ( Unit of Works )。

2.1 新規作成処理

新規作成する場合は、Table.InsertOnSubmit() を使用します。以下がサンプルメソッドです。

  1. ///
  2. /// Insert を行うテスト
  3. ///
  4. public static void InsertSalesReason()
  5. {
  6. AdventureWorksDataContext dc = new AdventureWorksDataContext(ConnectionString);
  7. SalesReason sr = new SalesReason() { Name = "Reason1", ReasonType = "type1", ModifiedDate = DateTime.Now };
  8. dc.Log = Console.Out;
  9. dc.SalesReasons.InsertOnSubmit(sr);
  10. dc.SubmitChanges();
  11. Console.WriteLine(sr.SalesReasonID.ToString());
  12. }

実行結果は次のようになります。下図で、input enter の上部に SalesReasonID が表示されています。この値は、SalesReason にレコードを新規作成するときに自動で採番される値です。登録時に設定される値は、ColumnAttribute.IsDbGenerated を true に設定しておくことで、登録後に値が設定されます。

2.2 更新処理

更新をする場合は、Entity クラスにデータを更新するだけで、トラッキングサービスにより、更新対象のオブジェクトとして認識されます。以下にサンプルメソッドを定義します。

  1. ///
  2. /// Update を行うテスト. Entity の列に ColumnAttribute.IsVersion=true の
  3. /// プロパティ、フィールドがあるかによって、楽観的排他制御用の where 句の生成方法が変わる
  4. ///
  5. public static void UpdateSalesReason()
  6. {
  7. AdventureWorksDataContext dc = new AdventureWorksDataContext(ConnectionString);

  9. SalesReason sr = dc.SalesReasons.Single(s => s.SalesReasonID == 11);
  10. sr.Name = "change with isversion";

  12. dc.Log = Console.Out;
  13. dc.SubmitChanges();
  14. }

実行結果は下図のようになります。下図の実行結果は、 SalesReason.ModifiedData に設定されているColumnAttribute.IsVersion を false にした際の実行結果です。作成されたSQL を見ると、WHERE 句にプライマリキー列だけではなく、他のすべての列を条件として列挙していることが確認できます。これは、IsVersion が設定されたプロパティ、フィールドがないと、他のユーザなどによりすでに更新されたレコードに対して、最新ではないデータで更新をさせないようにするための、排他制御を行う際に、すべての列に対して比較を行い、変更が加わっていない場合のみ更新を行うようにSQL が作成されるためです。

1. 使用する Entity クラスと AdventureWorksDataContext の定義 で掲載しているサンプルのように、SalesReason.ModifiedDataにアノテートした、ColumnAttribute.IsVersion を true にした場合は次のようになります。WHERE 句の排他制御用の条件がModifiedDate のみになっていることが確認できます。

2.3 削除処理

削除処理を行う場合は、 DataContext.DeleteOnSubmit() メソッドを使用します。サンプルプログラムを以下のように定義します。

  1. ///
  2. /// Delete を行うテスト
  3. /// Update と同様に Entity クラスのプロパティ、フィールドに
  4. /// ColumnAttribute.IsVersion = true がアノテートされたもの
  5. /// があるかにより、楽観的排他制御用の Where 句が変わる
  6. ///
  7. public static void DeleteSalesReason()
  8. {
  9. AdventureWorksDataContext dc = new AdventureWorksDataContext(ConnectionString);

  11. SalesReason sr = dc.SalesReasons.Single(s => s.SalesReasonID == 12);
  12. dc.SalesReasons.DeleteOnSubmit(sr);
  13. dc.Log = Console.Out;

  15. dc.SubmitChanges();
  16. }

Entity クラスのリレーションを更新する場合は、次のように直接参照を設定しなおすか、1対多のリレーションがある場合は、Add を呼び出します。

  1. ///
  2. /// リレーションのプロパティ、フィールドを変更する場合
  3. ///
  4. public static void UpdateRelation()
  5. {
  6. DataContext dc = new DataContext(ConnectionString);
  7. Table orders = dc.GetTable();

  9. var query = from o in orders
  10. select o;

  12. SalesOrder s1 = null;
  13. SalesOrder s2 = null;
  14. foreach (var item in orders.Take(2))
  15. {
  16. if (s1 == null)
  17. {
  18. s1 = item;
  19. }
  20. else
  21. {
  22. s2 = item;
  23. }
  24. }
  25. // 関係を更新
  26. Customer c = s1.Customer;
  27. s1.Customer = s2.Customer;
  28. s2.Customer = c;

  30. // 関係を追加
  31. SalesOrder added = new SalesOrder(){ DueDate=DateTime.Now, OrderDate=DateTime.Now.Add(new TimeSpan(1000))};
  32. c.SalesOrders.Add(added);

  34. dc.SubmitChanges();
  35. }

2.4 カスケーディングによる削除、更新

注文書と注文明細のように、注文書を削除した場合に注文明細を削除する(Cascading Delete) 場合や、複数の顧客をもつ担当営業にたいして、別の営業員に変更する(Cascading Update) などを行いたい場合があります。LINQ to SQL では、カスケーディングによる削除、更新はサポートしていませんので、開発者が自身で行う必要があります。

以下が、サンプルです。

  1. ///
  2. /// カスケードデリートを行う場合
  3. ///
  4. public static void CascadeDelete()
  5. {
  6. AdventureWorksDataContext dc = new AdventureWorksDataContext(ConnectionString);

  8. var query = from c in dc.Customers
  9. where c.CustomerID == 2
  10. select c;

  12. var customer = query.Single();
  13. dc.Customers.DeleteOnSubmit(customer);
  14. dc.SalesOrders.DeleteAllOnSubmit(customer.SalesOrders);
  15. ChangeSet set = dc.GetChangeSet();
  16. // SubmitChanges を呼び出すと削除処理が実行される
  17. //dc.SubmitChanges();
  18. }
  19. ///
  20. /// カスケード更新を行う場合
  21. /// CustomerのIDを更新する場合は、
  22. /// LINQ to SQL はプライマリキーの更新を許可していないので、新しい Customer
  23. /// クラスを作成して関連する SalesOrder の集合を設定しなおす必要がある。
  24. ///
  25. public static void CascadeUpdate()
  26. {
  27. AdventureWorksDataContext dc = new AdventureWorksDataContext(ConnectionString);

  29. var query = from c in dc.Customers
  30. where c.CustomerID == 2
  31. select c;
  32. Customer oldCustomer = query.Single();
  33. Customer newCustomer = new Customer() { FirstName = "First", LastName = "Last" };
  34. newCustomer.CustomerID = oldCustomer.CustomerID();
  35. newCustomer.SalesOrders = oldCustomer.SalesOrders;
  36. // 省略..そのほかプロパティを設定
  37. dc.Customers.DeleteOnSubmit(oldCustomer);
  38. dc.Customers.InsertOnSubmit(newCustomer);
  39. // DB に反映
  40. //dc.SubmitChanges();
  41. }

2.5 SubmitChanges 後の、Entity オブジェクトのプロパティ、フィールド値のテーブルのカラム値との自動同期について

SubmitChanges メソッドにより更新や新規作成をデータベースに反映する場合、レコードの値がトリガー処理によって変更される場合や自動採番列が存在してデータが新規作成される場合、レコードからデータを読み直すひつようがあります。新規作成、更新処理時にレコードから特定の列を読み直すかは、ColumnAttribute.AutoSync の値のよって指定します。AutoSync は System.Data.Linq.Mapping.AutoSync 列挙型の値を指定します。既定では Default で、その場合、IsDbGenerated が true の場合は、Insert 処理時に列の値が Entity のプロパティ、フィールドに設定されます。ColumnAttribute.IsVersion が true の場合は 更新、新規作成処理時にプロパティ、フィールドに値が設定されます。他の値は Always, Never, OnInsert, OnUpdate があります。詳細な内容については MSDN ドキュメントを参照して下さい。

2.6 Insert, Update, Delete 処理をカスタマイズする

DataContext の SubmitChanges(ConflictMode failureMode) をオーバーライドし、GetChangeSet() メソッドで変更対象の Entity オブジェクトを取得し、カスタム処理を記述すると、データベースへの反映処理をカスタマイズできます。この場合、全体のロジックを変更することになります。特定の Entity クラスに対して、動的に作成されたクエリではなく、ストアドプロシージャを呼びだしたり、監査ログを出力するなどの処理をすることで、新規作成、更新、削除処理をカスタマイズする場合は、各 Entity の名前に対応する特別なシグネチャをもつメソッドを DataContext を継承したクラスで定義することで行えます。

Insert 処理のシグネチャは、 public void InsertType(Type inserted){}, 更新処理のシグネチャは、 public void UpdateType(Type current){}, 削除処理のシグネチャは public void DeleteType(Type deleted){} となります。ここで、Type は Entity クラスの名前となります。SalesReason エンティティクラスに対して、カスタム処理を記述した場合のサンプル処理を以下に掲載します。各メソッドは DataContext を継承した AdventureWorksDataContext に定義されていとします。更新処理時に DataContext からリフレクションを使用して各シグネチャにマッチするメソッドが呼び出されます。

  1. ///
  2. /// 新規作成のカスタマイズ。
  3. /// DataContext からリフレクションを介して呼び出される。
  4. ///
  5. ///
  6. public void InsertSalesReason(SalesReason inserted)
  7. {
  8. // 監査ログ、プロパティの変更等を行える
  9. // 既定の処理ではなく、ストアドを実行する
  10. // ことも可能

  12. // デフォルトの新規作成処理を実行する場合
  13. this.ExecuteDynamicInsert(inserted);
  14. }
  15. ///
  16. /// 更新処理のカスタマイズ
  17. /// DataContext からリフレクションを介して呼び出される。
  18. ///
  19. ///
  20. public void UpdateSalesReason(SalesReason current)
  21. {
  22. // GetOriginalEntityState メソッドを使用しても変更前の状態の
  23. // オブジェクトにアクセス
  24. SalesReason original = SalesReasons.GetOriginalEntityState(current);

  26. int affectedRows = ExecuteCommand("exec dbo.usp_UpdateSalesReason @id={0}, @name={1}"
  27. , original.SalesReasonID, current.Name);
  28. if (affectedRows <>
  29. throw new ChangeConflictException();

  31. // デフォルトの更新処理を実行することもできる
  32. //this.ExecuteDynamicUpdate(current);
  33. }
  34. ///
  35. /// 削除処理のカスタマイズ実行
  36. /// DataContext からリフレクションを介して呼び出される。
  37. ///
  38. ///
  39. public void DeleteSalesReason(SalesReason deleted)
  40. {
  41. // 既定の削除処理
  42. this.ExecuteDynamicDelete(deleted);
  43. }

サンプルプログラムでも記載していますが、既定の新規作成、更新、削除を実行する場合は、それぞれ、 DataContext クラスの ExecuteDynamicInsert, ExecuteDynamicUpdate, ExecuteDynamicDelete メソッドを呼び出します。

カスタムInsert, Update, Delete 処理を実装した場合、排他制御の処理も開発者が責任を持つ必要があります。

2.7 排他制御発生と解決方法

DataContext.SubmitChanges() を呼び出したときに他ユーザによる更新などで、排他例外が発生すると、既定の処理では ChangeConflictException がスローされます。このとき発生したコンフリクトは、DataContext.ChangeConflicts に格納されています。 ChangeConflicts は ObjectChangeConflict インスタンスのコレクションです。ObjectChangeConflict.MemberConflicts には関係するメンバーにリストが格納されています。MemberConflicts プロパティはMemberChangeConflict クラスのインスタンスで、現在の Entity オブジェクトのプロパティ、フィールドの値CurrentValueと、 変更前の値 OriginalValue および、データベースの列値 DatabaseValue のプロパティを保持しています。排他例外が発生したテーブル名を調べる場合は、DataContext.Mapping.GetTable(objectChangeConflict.Object.GetType()) を呼び出すことで、MetaTable クラスにオブジェクトにアクセスして、テーブル名などのメタ情報にアクセスできます。ここで、objectChangeConflict はObjectChangeConflict クラスのインスタンスとします。

排他制御例外が発生した場合は、開発者はどのように例外を解決するかを決定する必要があります。排他制御を解決する場合は、DataContext を破棄してもう一度データを読み直すか、 DataContext.Refresh() メソッドを使用します。DataContext.Refresh メソッドには、 RefreshMode の列挙値を指定します。列挙値によってメモリ上にロードされている Entity オブジェクトを変更します。RefreshMode　はKeepChanges, KeepCurrentValue, OverwriteCurrentValues があります。詳細は MSDN ドキュメントを参照して下さい。

排他制御のコンフリクト発生の(Where 句に含めるかの判定)判定に使用されるプロパティ、フィールドとするかどうかは ColumnAttribute の UpdateCheck の値によって決定されます。指定できる値は Always, Never, WhenChanged です。例えば Never を指定すると、排他制御のチェック条件として Where 句に現れなくなります。各値の詳細はMSDN ドキュメントを参照して下さい。ただし、ColumnAttribute.IsVersion に true が設定されているプロパティ、フィールドがある場合は、UpdateCheck の指定は無効になります。

3 トランザクション処理

トランザクション処理は従来の DbTransaction を使用する方法と TransactionScope を使用する方法があります。TransactionScope は DTS (Data Transaction Coordinator) を使用するので、DbTransaction と較べればパフォーマンスが劣る可能性がありますが、オンライン処理で使用する少量のデータの場合はプログラムが比較的単純になる TransactionScope を使用しても問題がないと思います。

  1. ///
  2. /// DbTransaction を使用したトランザクション
  3. ///
  4. public static void DbTransactionVersion()
  5. {
  6. AdventureWorksDataContext dc = new AdventureWorksDataContext(ConnectionString);

  8. SalesReason sr = dc.SalesReasons.Single(s => s.SalesReasonID == 13);
  9. sr.Name = "change with Transaction";

  11. dc.Log = Console.Out;
  12. using (dc.Transaction = dc.Connection.BeginTransaction())
  13. {
  14. dc.SubmitChanges();
  15. dc.Transaction.Commit();
  16. }
  17. }
  18. ///
  19. /// TransactionScope を使用したトランザクション
  20. /// System.Transactions.dll の参照の追加が必要
  21. ///
  22. public static void TransactionScopeVersion()
  23. {
  24. AdventureWorksDataContext dc = new AdventureWorksDataContext(ConnectionString);
  25. SalesReason sr = dc.SalesReasons.Single(s => s.SalesReasonID == 13);
  26. sr.Name = "change with TransactionScope";

  28. dc.Log = Console.Out;
  29. using (TransactionScope ts = new TransactionScope())
  30. {
  31. dc.SubmitChanges();
  32. ts.Complete();
  33. }
  34. }

4. その他(非接続環境の対応)

SOA 環境でLINQ to SQL を使用するときに、Entity クラスをシリアライズする場合は、DataContractSerializer を使用するようにします。SQL Metal や Visual Studio 2008 のデザイナを使用すれば、DataContract がアノテートされた Entity クラスを自動生成してくれるようになります。シリアライズされた Entity オブジェクトをトラッキングサービスにアタッチするには、 Table.Attach メソッドを使用します。サンプルで掲載した例を使用するとAdventureWorksDataContext.SalesReasons.Attach( salesReasonObject ) のように呼び出します。　Attach のオーバーライド版を使用すると、変更されたオブジェクトとしてシリアライズされた Entity オブジェクトを DataContext にアタッチできます。

Entity クラスからテーブルを作成することができます。AdventureWorksDataContext.CreateDatabase(), DeleteDatabase() を使用してテーブルの作成、削除を行えます。テーブルの作成、削除を行うためには、Entity クラスのプロパティ、フィールドに付与された ColumnAttribute の DbType を設定しておく必要があります。

投稿者 時刻:

0 件のコメント:

コメントを投稿

登録: コメントの投稿 (Atom)