名前¶

File::Transaction - ファイルの集合へのトランザクション的な変更

概要¶

  #
  # この例では、私は複数のファイルにある'foo'という単語を'bar'で
  # 置き換えようとしています。そしていくつかのファイルで置換が
  # おこなわれ、他のものでは行われないまま終わらせてしまう
  # 危険性を最小限にしたいと思っています。
  #

  use File::Transaction;

  my $ft = File::Transaction->new;

  eval {
      foreach my $file (@list_of_file_names) {
          $ft->linewise_rewrite($file, sub {
               s#\bfoo\b#bar#g;
          });
      }
  };

  if ($@) {
      $ft->revert;
      die "update aborted: $@";
  }
  else {
      $ft->commit;
  }

説明¶

File::Transaction オブジェクトはファイルの集合への変更をカプセル化します。最初にそれぞれのファイルの新しいバージョンを出力し、全てを新しいバージョンで置き換えることにより行われます。ファイルの集合はもしrenameシステム・コールが失敗するか、 Perlプロセスがcommit()の途中で中断された場合にのみ、一貫していない状態で終了します。

ファイルはトランザクションに追加された順にコミットされます。もしcommit()が途中で失敗ときのダメージを限定するため、この順番は注意して選択されなければなりません。もし何も順序がなければ、部分的なコミットが容認されます、代わりに File::Transaction::Atomicを使うことを考えてください。

コンストラクタ¶

new ( [TMPEXT] )

新しく空のFile::Transactionオブジェクトを作成します。

TMPEXTパラメータは新しいバージョンのためのテンポラリ・ファイル名を作るためファイル名に追加される文字列を与えます。デフォルトは.tmpです。

メソッド¶

linewise_rewrite ( OLDFILE, CALLBACK )

ファイルOLDFILEの新しいバージョンを出力し、トランザクションに追加し、ファイルの各行について一回ずつコードリファレンスCALLBACKを$_に行を入れて呼び出します。新しいファイルの名前はnew()に渡された TMPEXTをOLDFILEに追加することにより生成されます。そしてもしあれば、このファイルは上書きされます。

コールバックはそれを呼び出したFile::Transactionオブジェクトの commit()あるいはrevert()メソッドを呼び出してはいけません。

このメソッドはエラーのさいに最初にトランザクション中にある他のファイルを元に戻すことなくdie()を呼び出します。

addfile ( OLDFILE, TMPFILE )

トランザクションに1つのファイルへの更新を追加します。OLDFILEはそのファイルの古いバージョンの名前です。そしてTMPFILEは、それに新しいバージョンが書き込まれる一時ファイルの名前です。

commit()のさい、OLDFILEはTMPFILEで置換されます。そしてTMPFILEは revert()のさい、削除されます。OLDFILEは存在する必要がありません。

revert ()

addfile()メソッドで、それまでに作成されたファイルの新しいバージョンを削除します。エラーのときにはdieします。

commit ()

それまでに作成された全ての新しいバージョンを正しい場所に入れ替えます。エラーのときにはdieします。

バグ¶

もしcommit()メソッドの中でrenameが失敗したり、Perlプロセスが中断されると、いくつかのファイルは更新されますが、他のものは更新されません。もしそれが問題であれば、File::Transaction::Atomicをご覧ください。

参考資料¶

File::Transaction::Atomic

作者(=AUTHOR)¶

Nick Cleaton <[email protected]>

著作権(=COPYRIGHT)¶

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

翻訳者¶

川合孝典([email protected])