Tripletail::DB - DBI のラッパ

TABLE OF CONTENTS

NAME

Tripletail::DB - DBI のラッパ

SYNOPSIS

  $TL->startCgi(
      -DB      => 'DB',
      -main        => \&main,
  );
  
  sub main {
    my $DB = $TL->getDB('DB');
    
    $DB->setDefaultSet('R_Trans');
    $DB->tx(sub{
      my $sth = $DB->execute(q{SELECT a, b FROM foo WHERE a = ?}, 999);
      while (my $hash = $sth->fetchHash) {
        $TL->print($hash->{a});
      }
      # commit is done implicitly.
    });
    
    $DB->tx('W_Trans' => sub{
      $DB->execute(q{UPDATE counter SET counter = counter + 1 WHERE id = ?}, 1);
      $DB->commit; # can commit explicitly.
    }
  }

DESCRIPTION

接続/切断は自動で行われる。

手動で接続/切断する場合は、connect/disconnectを使うこともできるが、なるべく使用しないことを推奨。

実行クエリの処理時間・実行計画・結果を記録するデバッグモード。

prepare/executeを分けない。fetchは分けることもできる。

拡張プレースホルダ機能

  $db->execute(q{select * from a where mode in (??)}, ['a', 'b'])

と記述すると、

  $db->execute(q{select * from a where mode in (?, ?)}, 'a', 'b')

のように解釈される。

プレースホルダの値渡しの際に型指定が可能

  $db->execute(q{select * from a limit ??}, [10, \'SQL_INTEGER'])

型指定ができるのは拡張プレースホルダのみです. 通常の ? によるプレースホルダではエラーとなります.

リクエスト処理完了後のトランザクション未完了やunlock未完了を自動検出

DBグループ・DBセット・DBコネクション

Tripletail::DBでは、レプリケーションを利用してロードバランスすることを支援するため、１つのDBグループの中に、複数のDBセットを定義することが可能となっている。 DBセットの中には、複数のDBコネクションを定義できる。

更新用DBセット、参照用DBセット、などの形で定義しておき、プログラム中でトランザクション単位でどのDBセットを使用するか指定することで、更新用クエリはマスタDB、参照用クエリはスレーブDB、といった使い分けをすることが可能となる。

DBセットには複数のDBコネクションを定義でき、複数定義した場合はプロセス単位でプロセスIDを元に1つのコネクションが選択される。（プロセスIDを定義数で割り、その余りを使用して決定する。）

同じDBグループの中の複数のDBセットで同じDBコネクション名が使用された場合は、実際にDBに接続されるコネクション数は1つとなる。このため、縮退運転時に参照用DBセットのDBコネクションを更新用のものに差し替えたり、予め将来を想定して多くのDBセットに分散させておくことが可能となっている。

DBセットの名称はSET_XXXX(XXXXは任意の文字列)でなければならない。 DBコネクションの名称はCON_XXXX(XXXXは任意の文字列)でなければならない。

いずれのDBコネクションも利用可能である必要があり、接続できなかった場合はエラーとなる。

DBのフェイルオーバーには（現時点では）対応していない。

DBI からの移行

Tripletail の DB クラスは DBI に対するラッパの形となっており、多くのインタフェースは DBI のものとは異なる。ただし、いつでも $DB->getDbh() メソッドにより元の DBI オブジェクトを取得できるので、 DBI のインタフェースで利用することも可能となっている。

DBI のインタフェースは以下のようなケースで利用できる。ただし、 DBI を直接利用する場合は、TLの拡張プレースホルダやデバッグ機能、トランザクション整合性の管理などの機能は利用できない。

ラッパに同等の機能が用意されていない場合。
高速な処理が必要で、ラッパのオーバヘッドを回避したい場合。: DBI に対するラッパであるため、大量の SQL を実行する場合などはパフォーマンス上のデメリットがある。

DBI での SELECT は、以下のように置き換えられる。

 # DBI
 my $sth = $DB->prepare(q{SELECT * FROM test WHERE id = ?});
 $sth->execute($id);
 while(my $data = $sth->fetchrow_hashref) {
 }
 # TL
 my $sth = $DB->execute(q{SELECT * FROM test WHERE id = ?}, $id);
 while(my $data = $sth->fetchHash) {
 }

TL では prepare/execute は一括で行い、 prepared statement は利用できない。

INSERT・UPDATEは、以下のように置き換えられる。

 # DBI
 my $sth = $DB->prepare(q{INSERT INTO test VALUES (?, ?)});
 my $ret = $sth->execute($id, $data);
 # TL
 my $sth = $DB->execute(q{INSERT INTO test VALUES (?, ?)}, $id, $data);
 my $ret = $sth->ret;

prepare/execute を一括で行うのは同様であるが、 execute の戻り値は$sthオブジェクトであり、影響した行数を取得するためには $sth->ret メソッドを呼ぶ必要がある。

プレースホルダの型指定は以下のように行う。

 # DBI
 my $sth = $DB->prepare(q{SELECT * FROM test LIMIT ?});
 $sth->bind_param(1, $limit, { TYPE => SQL_INTEGER });
 $sth->execute;
 # TL
 my $sth = $DB->execute(q{SELECT * FROM test LIMIT ??}, [$limit, \'SQL_INTEGER']);

TLの拡張プレースホルダ（??で表記される）を利用し、配列のリファレンスの最後に型をスカラのリファレンスの形で渡す。拡張プレースホルダでは、複数の値を渡すことも可能である。

 # DBI
 my $sth = $DB->prepare(q{SELECT * FROM test LIMIT ?, ?});
 $sth->bind_param(1, $limit, { TYPE => SQL_INTEGER });
 $sth->bind_param(2, $offset, { TYPE => SQL_INTEGER });
 $sth->execute;
 # TL
 my $sth = $DB->execute(q{SELECT * FROM test LIMIT ??}, [$limit, $offset, \'SQL_INTEGER']);

INSERTした行のAUTO_INCREMENT値の取得は、getLastInsertId で行える。

 # DBI
 my $id = $DB->{mysql_insertid};
 # TL
 my $id = $DB->getLastInsertId;

拡張ラッパでは制御できない機能にアクセスする場合などは、 DBI のハンドラを直接利用する。

 # DBI
 my $id = $DB->{RowCacheSize};
 # TL
 my $id = $DB->getDbh()->{RowCacheSize};

トランザクションには $DB->tx(sub{...}) メソッドを用いる。 DBセットを指定する時には $DB->tx(dbset_name=>sub{...}) となる。渡したコードをトランザクション内で実行する。 die なしにコードを抜けた時に自動的にコミットされる。途中で die した場合にはトランザクションはロールバックされる。

 # DBI
 $DB->do(q{BEGIN WORK});
 #   do something.
 $DB->commit;
 
 # TL
 $DB->tx(sub{
   # do something.
 });

begin() メソッドも実装はされているがその使用は非推奨である。また、 $DB->execute(q{BEGIN WORK}); として利用することはできない。

拡張プレースホルダ詳細

"execute" に渡される SQL 文には、通常のプレースホルダの他に、拡張プレースホルダ "??" を埋め込む事が出来る。拡張プレースホルダの置かれた場所には、パラメータとして通常のスカラー値でなく、配列へのリファレンスを与えなければならない。配列が複数の値を持っている場合には、それらが通常のプレースホルダをカンマで繋げたものに展開される。

例: 以下の二文は等価

  $DB->execute(
      q{SELECT * FROM a WHERE a IN (??) AND b = ?},
      ['AAA', 'BBB', 'CCC'], 800);
  
  $DB->execute(
      q{SELECT * FROM a WHERE a IN (?, ?, ?) AND b = ?},
      'AAA', 'BBB', 'CCC', 800);

パラメータとしての配列の最後の項目が文字列へのリファレンスである時、その文字列は SQL 型名として扱われる。配列が複数の値を持つ時には、その全ての要素に対して型指定が適用される。型名はDBI.pmで定義される。

例:

  $DB->execute(q{SELECT * FROM a LIMIT ??}, [20, \'SQL_INTEGER']);
  ==> SELECT * FROM a LIMIT 20
  
  $DB->execute(q{SELECT * FROM a LIMIT ??}, [20, 5, \'SQL_INTEGER']);
  ==> SELECT * FROM a LIMIT 20, 5

配列内の要素を更に2要素の配列とし、二番目の要素を文字列へのリファレンスとする事で、要素の型を個別に指定出来る。

例:

  $DB->execute(
      q{SELECT * FROM a WHERE a IN (??) AND b = ?},
      [[100, \'SQL_INTEGER'], 'foo', \'SQL_VARCHAR'], 800);
  ==> SELECT * FROM a WHERE a IN (100, 'foo') AND b = '800'

Ini パラメータ

DBセット・DBコネクション

DBグループのパラメータのうち、半角小文字英数字のみで構成されたパラメータは予約済みで、DBグループの動作設定に使用する。 DBセットは、予約済みではない名前であれば任意の名称が使用でき、値としてDBコネクションのINIグループ名をカンマ区切りで指定する。

例:

  [DB]
  namequery=1
  autoretry=1
  type=mysql
  defaultset=SET_R_Trans
  SET_W_Trans=CON_DBW1
  SET_R_Trans=CON_DBR1,CON_DBR2
  
  [CON_DBW1]
  dbname=test
  user=daemon
  host=192.168.0.100
  
  [CON_DBR1]
  dbname=test
  user=daemon
  host=192.168.0.110
  
  [CON_DBR2]
  dbname=test
  user=daemon
  host=192.168.0.111

以下は特別なパラメータ:

namequery

  namequery = 1

これを1にすると、実行しようとしたクエリのコマンド名の直後に /* foo.pl:111 [DB.R_Transaction1.DBR1] */ のようなコメントを挿入する。デフォルトは0。

autoretry

  autoretry = 1

これを 1 にすると "tx" を用いて実行されたトランザクションがデッドロックにより失敗した場合に自動的にトランザクションを再実行する。データベースがデッドロック検出機構を持っていない場合には再実行は行われない。デフォルトは 0。

なお単体の "execute" がデッドロックを起こした場合には、この設定とは無関係に必ず再実行される。

type

  type = mysql

DBの種類を選択する。 mysql, pgsql, oracle, interbase, sqlite, mssql が使用可能。必須項目。

defaultset

  defaultset = SET_W_Trans

デフォルトのDBセットを設定する。ここで設定されたDBセットは、引数無しのbegin()や、beginせずに行ったexecuteの際に使われる。

DB定義

dbname

  dbname = test

DB名を設定する。

host

  host = localhost

DBのアドレスを設定する。デフォルトはlocalhost。

user

  user = www

DBに接続する際のユーザー名を設定する。

password

  password = PASS

DBに接続する際のパスワードを設定する。省略可能。

mysql_read_default_file

  mysql_read_default_file = .../tl_mysql.cnf

mysql クライアントライブラリが使用する設定ファイル my.cnf のパスを指定する。パスの指定を .../ で始めることで、 ini ファイルからの相対パスとして指定する事も可能。設定ファイルを使用する事で、 default-character-set 等の Tripletail::DB や DBD::mysql からは設定できない項目が設定できる。また、設定ファイルで user, password, host 等の値を指定する場合は、 Ini パラメータのDBコネクションの値を省略する事ができる。(dbname だけは省略できない)

mysql_read_default_group

  mysql_read_default_group = tripletail

mysql_read_default_file 指定時に、設定ファイル中のどのグループを使用するかを指定する。グループを指定した場合は、 [client] グループの設定と指定したグループの設定の両方が有効になる。グループを指定しない場合、 [client] グループの設定のみが有効となる。

SQL Server 設定

試験的に SQL Server との接続が実装されています. DBD::ODBC と, Linux であれば unixODBC + freetds で, Windows であれば組み込みの ODBC マネージャで動作します.

設定例:

 # <tl.ini>
 [DB]
 type=mssql
 defaultset=SET_W_Trans
 SET_W_Trans=CON_RW
 [CON_RW]
 # dbname に ODBC-dsn を設定.
 dbname=test
 user=test
 password=test
 # freetds経由の時は, そちらのServernameも指定.
 tdsname=tds_test

freetds での接続文字コードの設定は freetds.conf で設定します.

 ;; <freetds.conf>
 [tds_test]
 host = 10.0.0.1
 ;;port = 1433
 tds version = 7.0
 client charset = UTF-8

AUTHOR INFORMATION

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

このフレームワークはフリーソフトウェアです。あなたは Perl と同じライセンスの元で再配布及び変更を行うことが出来ます。

Address bug reports and comments to: tl@tripletail.jp

HP : http://tripletail.jp/

Tripletail::DB - DBI のラッパ

INDEX

$TL->getDB
$TL->newDB
AUTHOR INFORMATION
DBI からの移行
DBグループ・DBセット・DBコネクション
DBセット・DBコネクション
DB定義
DESCRIPTION
Ini パラメータ
METHODS
NAME
SEE ALSO
SQL Server 設定
SYNOPSIS
Tripletail::DB メソッド
Tripletail::DB::Sth メソッド
autoretry
begin
commit
connect
dbname
defaultset
disconnect
escapeLike
execute
fetchArray
fetchHash
findTables
finish
getDbh
getLastInsertId
getTableColumns
getType
host
inTx
lock
mysql_read_default_file
mysql_read_default_group
nameArray
nameHash
namequery
password
prepare/executeを分けない。fetchは分けることもできる。
quote
ret
rollback
rows
selectAllArray
selectAllHash
selectRowArray
selectRowHash
setBufferSize
setDefaultSet
symquote
tx
type
unlock
upsert
user
プレースホルダの値渡しの際に型指定が可能
ラッパに同等の機能が用意されていない場合。
リクエスト処理完了後のトランザクション未完了やunlock未完了を自動検出
実行クエリの処理時間・実行計画・結果を記録するデバッグモード。
拡張プレースホルダ機能
拡張プレースホルダ詳細
接続/切断は自動で行われる。
高速な処理が必要で、ラッパのオーバヘッドを回避したい場合。

Tripletail::DB - DBI のラッパ

NAME

SYNOPSIS

DESCRIPTION

DBI からの移行

拡張プレースホルダ詳細

METHODS

`Tripletail::DB` メソッド

`Tripletail::DB::Sth` メソッド

Ini パラメータ

DBセット・DBコネクション

DB定義

SQL Server 設定

SEE ALSO

AUTHOR INFORMATION

INDEX