Ruby DBI モジュールを使う

Paul DuBois
paul@kitebird.com
訳者
久保健洋
kubo@jiubao.org

Original Document revision: 1.02
Original Last update: 2003-05-27
翻訳バージョン: 0.9.5

はじめに

Ruby DBI を使うと、いろんな種類のデータベースを同じAPIでもってrubyからアクセスすることができます。これは、Perl DBI と perl の関係と同じです。この記事では Ruby DBI を使用したRubyスクリプトの書き方を説明します。この文書は DBI 仕様書に説明を追加するものであって、DBI 仕様書そのものを置き換えるものではありません。したがって、DBI 仕様書は必ず読んでください。本文書で足りない場合は、「参考情報」を参照してください。

Ruby DBI のアーキテクチャはおおまかに以下の２つの層(レイヤ)から成り立っています。

1. DBI(データベースインターフェース)層。この層はデータベースに依存しない層です。使用するデータベースの種類がどんなものでも、この層のAPIを使用すると同じ操作でもって接続することができます。
2. DBD(データベースドライバ)層。この層はデータベースに依存する層です。データベースの種類毎に別々の種類のドライバが必要となります。例えば、 MySQL用、PostgreSQL用、InterBase用、Oracle用等々、様々なドライバがあります。各ドライバはDBI層から渡ってくるリクエストを受けとり、対応するデータベースに適したリクエストへと変換します。

この記事では MySQL データベースドライバを例にとります。しかしあなたの使用するデータベースが MySQL でなくても、ほとんどのことは同様に使用することができます。

前準備

Ruby DBI は汎用的なDBI層のコードと、DBDレベルの様々なドライバから成り立っています。これらのドライバを使用するときにはほとんどの場合、それ用のソフトウェアを追加でインストールする必要があります。例えば MySQL の DBDドライバそのものは Ruby で書かれており、DBIから渡されたリクエストを Ruby MySQL モジュールのリクエストへと変換して渡します。そして、Ruby MySQL モジュールそのものは C で書かれており、DBDドライバから渡されたリクエストを MySQL の C クライアントライブラリへと変換して渡します。つまり、DBI を使うスクリプトを書いて、MySQL データベースへと接続する場合には、Ruby MySQL モジュールと C API との両方を追加インストールする必要があります。Ruby MySQL モジュールについての情報は「参考情報」に記載されている参考文献を見てください。ここでは MySQL モジュールはすでにインストールされており、使用できる状態にあるとみなします。

インストール

MySQL の C クライアントライブラリと Ruby MySQL モジュールの準備が終わったら、Ruby DBI モジュールのインストールが可能となります。Ruby DBI モジュールは以下のサイトから取得できます。

   http://rubyforge.net/projects/ruby-dbi/

DBIモジュールは圧縮されたtarファイルとして配布されているので、ダウンロードした後に展開する必要があります。例えば、現在のバージョンが 0.0.19 とすると、配布ファイルは以下のコマンドで展開されます。

   % tar zxf ruby-dbi-all-0.0.19.tar.gz
   (訳者註: GNU tar の場合)
   % gunzip < ruby-dbi-all-0.0.19.tar.gz | tar xf -
   (訳者註: 商用UNIXのOS附属の tar の場合)

配布パッケージを展開したら、展開したファイルのトップディレクトリへ移動し、そのディレクトリにある setup.rb スクリプトを使ってインストールするパッケージの特定を行います。一般的には、以下のように config 引数の後にはなにも引数をつけません。

   % ruby setup.rb config

このように実行すると、デフォルトですべてのドライバがインストール対象となります。インストールするドライバを選択したい場合、--with オプションにドライバの名前を列挙します。例えば、DBI のメイン部分と MySQL の DBD レベルのドライバのみをインストールするときは、次のコマンドを発行します。

   % ruby setup.rb config --with=dbi,dbd_mysql

インストールパッケージの設定が終わったら、ビルドしてインストールします。

   % ruby setup.rb setup
   % ruby setup.rb install

このコマンドは root で実行しなければならない場合があります。

この記事では以降、以下の表記を慣習として使用します。

"DBI モジュール" はデータベース独立のレイヤを意味すると文脈上示されないかぎり、DBI層とDBD層のドライバをまとめて指します。
"DBD::Mysql" はDBIのMySQL用データベースドライバを指します。
"Ruby MySQL モジュール" はDBD::Mysqlの土台となるCで書かれたモジュールを指します。

単純なDBIスクリプト

Ruby DBI モジュールがインストールされているなら、Rubyプログラムから MySQL サーバへ接続できるようになっています。この記事では、サーバはローカルホストで動いており、test という名前のデータベースへ testuser、testpass というユーザ名、パスワードで接続できるとみなします。testuser を作成するには、MySQL の root ユーザでサーバへ接続して次の文を発行してください。

   mysql> GRANT ALL ON test.* TO 'testuser'@'localhost' IDENTIFIED BY 'testpass';

test データベースがない場合は、次の文を発行してデータベースを作成してください。

   mysql> CREATE DATABASE test;

別のサーバホスト、ユーザ名、パスワード、データベース名を使用したい場合は、この記事の以降のスクリプトにでてくる値を適切な値に置き換えてください。

次のスクリプトsimple.rbは、サーバへ接続して、サーバのバージョンを取得して、表示して、接続を切るだけの短いDBIプログラムです。このスクリプトは「参考情報」のリンクからダウンロードできます。テキストエディタで直接作成してもかまいません。

   # simple.rb - Ruby DBI を使用した簡単なMySQLスクリプト

   require "dbi"

   begin
       # MySQLサーバへ接続
       dbh = DBI.connect("dbi:Mysql:test:localhost", "testuser", "testpass")
       # サーババージョンの文字列を取得して、表示する。
       row = dbh.select_one("SELECT VERSION()")
       puts "Server version: " + row[0]
   rescue DBI::DatabaseError => e
       puts "An error occurred"
       puts "Error code: #{e.err}"
       puts "Error message: #{e.errstr}"
   ensure
       # サーバから切断
       dbh.disconnect if dbh
   end

simple.rbスクリプトからはDBIの基本的なコンセプトが読み取れます。このセクションの残りではDBIがどのように働くかを説明し、次のセクションからDBIプログラミング特有の側面について例を出しつつ詳細に記述していきます。

simple.rbはDBIモジュール要求するrequireの行から始まります。この行がないと、DBI メソッド呼び出しが失敗します。スクリプトの残り部分はbegin/rescue/ensureの中に置いてあります。

beginブロックではデータベース処理をすべてあつかいます。
rescueブロックでは例外が起こったときの処理をあつかい、エラー情報を取得して画面に表示します。
ensureブロックではデータベースサーバへの接続がどんな状態でも確実に閉じられるようにします。

connectメソッドはデータベースサーバへの接続を確立し、サーバとの通信に使用するデータベースハンドルを戻します。第一引数には、ドライバ名(MySQLの場合はMysql)、デフォルトのデータベース名、サーバのホスト名を示すデータソース名(DSN, data source name)をわたします。第二引数と第三引数は MySQL アカウントのユーザ名とパスワードです。DSNの値を書く方法は他にもあります。他の方法に関しては後のセクションの「サーバ接続の補足」であつかわれます。

simple.rbはデータベースハンドルを使ってselect_oneメソッドを呼んでいます。このメソッドは、問い合わせをサーバへ送り、結果列の最初の行を配列として戻すメソッドです。問い合わせSELECT VERSION()は値をひとつ戻します。したがって、バージョン文字列は row[0]として利用できます。これは配列の最初のそしてただひとつの項目です。スクリプトを走らせると、結果はこのように表示されます。

   % ruby simple.rb
   Server version: 4.0.13-log

エラーが起こると例外が上ります。様々な種類の例外が起こり得ます。しかし、データベースの操作に関するエラーのほとんどは DatabaseError例外を引き起こします。この例外のオブジェクトは errとerrstrの属性を持っていて、エラー番号とエラーの内容を記述したメッセージを意味します。 simple.rbはデータベース例外に関連するこれらの値を取得して出力し、その他の種類の例外は無視します。(本来ならば、rescue ブロック内で例外を作成し、呼び出し元のコードにわたして処理するべきです。)

simple.rbはdisconnectメソッドを呼んでサーバへの接続を切ります。切断はensureブロックで行い、問い合せを処理している最中にエラーが起きても接続が確実に切られるようにします。

問合せ処理

RUby DBI を用いてSQL文を実行する方法はたくさんあります。このセクションででそのうちの何種類かを使用します。ここで記述されなかった方法についてはDBI仕様書を参照してください。

本文書で使用するサンプルスクリプトは、大抵の場合、peopleという名前のテーブルを使用します。このテーブルは以下の構造をしています。

   CREATE TABLE people
   (
       id INT UNSIGNED NOT NULL AUTO_INCREMENT,    # ID番号
       name CHAR(20) NOT NULL,                     # 名前
       height FLOAT,                               # 身長(インチ単位)
       PRIMARY KEY (id)
   );

結果セットを返さない問合せ処理

行を返さないSQL文は、データベースハンドルのdoメソッドでもって実行できます。このメソッドは問い合せ文字列１つを引数にとり、問い合わせの実行で影響の受けた行を戻します。次の例はdoを何回も使用して、 peopleテーブルを作成し小さなテーブルデータを挿入します。

   dbh.do("DROP TABLE IF EXISTS people")
   dbh.do("CREATE TABLE people (
           id INT UNSIGNED NOT NULL AUTO_INCREMENT,
           PRIMARY KEY (id),
           name CHAR(20) NOT NULL,
           height FLOAT)")
   rows = dbh.do("INSERT INTO people (name,height)
           VALUES('Wanda',62.5),('Robert',75),('Phillip',71.5),('Sarah',68)")
   printf "%d rows were inserted\n", rows

INSERT文の実行箇所を見てください。スクリプト内でどれだけの数の行がテーブルに追加されたか取得し、画面に表示しています。

結果セットを返す問合せ処理

SELECTやSHOWといったSQL文は行を戻します。このような SQL文を処理するには、SQL文をサーバへ送信して実行し、生成された結果セットに含まれる行を取得して、最後に結果セットを破棄する必要があります。

実行方法は何種類もありますが、ここではprepareメソッドを呼んで文ハンドルを生成し、このハンドルを使用して文を実行し、実行結果を得て、結果セットを解放する方法を使用します。

   sth = dbh.prepare(SQL文)
   sth.execute
   ... 行を取得 ...
   sth.finish

SQL文を直接executeにわたして、prepareの呼び出しをスキップする方法もあります。

   sth = dbh.execute(SQL文)
   ... 行を取得 ...
   sth.finish

SQL文を実行した後に結果セットから検索結果を得る方法は何種類もあります。そのうちの一つとして、fetchをブロックなしで呼び出しで、 nilが戻るまでループする方法があります。

   sth = dbh.execute("SELECT * FROM people")
   while row = sth.fetch do
       printf "ID: %d, Name: %s, Height: %.1f\n", row[0], row[1], row[2]
   end
   sth.finish

fetchはイテレータとして使う方法もあります。これは eachをイテレータとして呼んだときと同じです。fetchも eachも等価です。

   sth = dbh.execute("SELECT * FROM people")
   sth.fetch do |row|
       printf "ID: %d, Name: %s, Height: %.1f\n", row[0], row[1], row[2]
   end
   sth.finish

   sth = dbh.execute("SELECT * FROM people")
   sth.each do |row|
       printf "ID: %d, Name: %s, Height: %.1f\n", row[0], row[1], row[2]
   end
   sth.finish

fetchとeachはDBI::Rowオブジェクトを生成します。行の中身をアクセスするには、DBI::Rowオブジェクトのメソッドを使用します。

行オブジェクト(DBI::Row)のデータを数字や名前でカラムのデータにアクセスするには、by_indexやby_fieldを使用します。
```
   val = row.by_index(2)
   val = row.by_field("height")
```
カラムの値へのインデックスや名前でのアクセスは、配列の表記法でも行うことができます。
```
   val = row[2]
   val = row["height"]
```

イテレータのメソッドeach_with_nameはカラムの名前といっしょにカラムの値を取り出します。

   sth = dbh.execute("SELECT * FROM people")
   sth.each do |row|
       row.each_with_name do |val, name|
           printf "%s: %s, ", name, val.to_s
       end
       print "\n"
   end
   sth.finish

DBI::Rowオブジェクトにはcolumn_namesメソッドもあります。このメソッドは各カラムの名前からなる配列を戻します。 field_namesはcolumn_namesの別名です。

結果セットより検索結果を取得するメソッドは他に、fetch_arrayとfetch_hash があります。このメソッドはDBI::Rowオブジェクトを戻しません。代りに検索結果を配列やハッシュとして戻し、それ以上行がないときはnilを戻します。fetch_hashで戻るハッシュはカラム名がキーでカラムの値が値となっています。どちらのメソッドもブロックなしでも、イテレータとしても呼ぶことができます。次はfetch_hashを使用した例です。

   sth = dbh.execute("SELECT * FROM people")
   while row = sth.fetch_hash do
       printf "ID: %d, Name: %s, Height: %.1f\n",
               row["id"], row["name"], row["height"]
   end
   sth.finish

   sth = dbh.execute("SELECT * FROM people")
   sth.fetch_hash do |row|
       printf "ID: %d, Name: %s, Height: %.1f\n",
               row["id"], row["name"], row["height"]
   end
   sth.finish

データベースハンドルのメソッドを利用すると、execute-fetch-finishの一連の操作を個々に実行しなくても良くなります。次のメソッドはこれらの仕事を一度に行い、結果を戻します。

   row = dbh.select_one(statement)
   rows = dbh.select_all(statement)

select_oneは問合せを実行して最初の一行を配列として戻します。問合せが一行も返さないときはnilを戻します。 select_allはDBI::Rowオブジェクトの配列を戻します。（このオブジェクトの中身は以前説明した方法にアクセスできます。）問合せが一行も返さないときは空の配列となります。

MySQLドライバは結果セットのメタデータを調べて行の値を対応するRubyのデータタイプへ変換します。（言い換えると、例えば、people テーブルから取り出されたid、name、heightの値がFixnum、String、Floatのオブジェクトとして戻されるということです。）しかし、カラムの値がNULLの場合は注意してください。この場合は、NULL値は結果セットではnilとして表現され、その種類はNilClassとなります。また、どのような型に変換するかはDBI仕様書では規定されておらず、DBDドライバによって変換先が異なる場合があります。

クオート、プレースホルダー、パラメータ束縛

Ruby DBI にはプレースホルダー機構があり、問合せ文字列のデータの値を直接取り込まなくても良いようになっています。代わりにSQL文の中に特別な印をつけて、データの値が入る場所を示します。SQL文を実行するときには、プレースホルダーにバインドする値を与えておきます。DBIはプレースホルダーの現れる場所のSQL文をバインドした値に置き換えます。このとき文字列の値はクオートで囲って、必要なら特殊文字をエスケープします。これを使うと、与えようとする文字に特殊文字が含まれているかどうか気にせずに、また、自身でクオートで囲うことなしに簡単にSQL文を組み立てることができます。プレースホルダー機構はNULL値も適切にあつかいます。 nilをデータとして与えるだけで、クオートされていない NULL値としてSQL文中に置かれます。

次の例はこれがどのように働くかを説明します。例として、クオートを含む Na'ilという名前で身長が76インチの人をpeopleテーブルにに追加すると想定しましょう。まず、データがINSERT文のどこに入るかを示すために、プレースホルダーの印'?'をシングルクオートなしで使い、次いで、doの引数にSQL文につづけて、追加の引数としてデータを与えます。

   dbh.do("INSERT INTO people (id, name, height) VALUES(?, ?, ?)",
           nil, "Na'il", 76)

doにより生成されてサーバへ送られる最終的なSQL文は次のようになります。

   INSERT INTO people (id,name,height) VALUES(NULL,'Na\'il',76)

SQLを何回も実行しようと考えている場合は、文ハンドルを得るために prepareで準備してから、executeでデータを引数として与えながら実行することができます。 people.txtという名のデータファイルに、peopleテーブルに挿入する名前/身長のペアがタブ区切りで行毎にはいっていると仮定しましょう。次の例はファイルを呼んで一行のデータを得て、前もって準備した INSERT文を各行ごとに実行します。

   # 挿入ループで使用する文ハンドルを用意する。
   sth = dbh.prepare("INSERT INTO people (id, name, height) VALUES(?, ?, ?)")

   # ファイルから一行づつ読んで、値に分けて、データベースへ挿入する。
   f = File.open("people.txt", "r")
   f.each_line do |line|
       name, height = line.chomp.split("\t")
       sth.execute(nil, name, height)
   end
   f.close

SQL文を prepare した後にループ内で何回も実行したほうが、ループ毎に doを呼び出す(繰り返し毎にprepareとexecuteの両方を呼ぶのと同等)よりも効率的です。問い合わせ実行計画を準備して、 executeの呼び出し毎に実行計画を再利用するデータベースの場合、これは重大な効率上の差異となります。MySQLは実行計画を再利用はできませんが、Oracleは再利用します。

SELECT文にプレースホルダーを使う場合、SQL文を最初の準備するかにするかどうかで適切な方法がかわります。

prepareメソッドで文ハンドルを作成した場合、文ハンドルに対してexecuteを呼んで、プレースホルダーにバインドするデータをわたします。

   sth = dbh.prepare("SELECT * FROM people WHERE name = ?")
   sth.execute("Na'il")
   sth.fetch do |row|
       printf "ID: %d, Name: %s, Height: %.1f\n", row[0], row[1], row[2]
   end
   sth.finish

prepareを使わない場合は、executeの第一引数はSQL文にして、続けてプレースホルダーにバインドするデータをわたします。

   sth = dbh.execute("SELECT * FROM people WHERE name = ?", "Na'il")
   sth.fetch do |row|
       printf "ID: %d, Name: %s, Height: %.1f\n", row[0], row[1], row[2]
   end
   sth.finish

他のドライバは別の形式のプレースホルダーでも受け付けるかもしれません。また、別の形式でないと受け付けないかもしれません。例えば、プレースホルダーを :name や :n として名前付きや数値付きの形式で書けるかもしれません。

quoteメソッドはデータ値をクオートで囲い、特殊文字をエスケープして、結果を戻します。これは他のプログラムで実行するSQL文を組み立てるのに便利です。例えば、データファイルpeople.txtを読んで、 INSERT文のかたまりに変形して、コマンドラインクライアントの mysqlといったプログラムで処理させる場合、次のようにします。

   # ファイルから一行づつ読んで、値に分けて、INSERT文を書き出す。
   f = File.open("people.txt", "r")
   f.each_line do |line|
       name, height = line.chomp.split("\t")
       printf "INSERT INTO people (id, name, height) VALUES(%s, %s, %s);\n",
               dbh.quote(nil), dbh.quote(name), dbh.quote(height)
   end
   f.close

メタデータの問い合わせ

INSERTやDELETEといった結果セットを戻さないSQL文の場合、doメソッドは処理された行数を戻します。

SELECTといった行を戻すSQL文の場合、executeを呼んだ後に文ハンドルを使い、結果セットの行数やカラム数、個々のカラムの情報を得ることができます。

行数やカラム数は直接には利用することはできません。行数を得るためには、 fetchで取り出した行をカウントするか、適当なデータ構造に入れて、そこに要素がどれだけあるかを調べてください。カラム数はカラム名の数から sth.column_names.sizeを利用して決定することができます。
column_infoメソッドは各カラムの情報を戻します。

次のスクリプトは問い合わせからメタデータを得る方法を示します。

   sth = dbh.execute(query)

   puts "問い合わせ: " + query
   if sth.column_names.size == 0 then
       puts "問い合わせには結果セットがありません。"
       printf "影響を受けた行の数: %d\n", sth.rows
   else
       puts "問い合わせには結果セットがあります。"
       rows = sth.fetch_all
       printf "行数:     %d\n", rows.size
       printf "カラム数: %d\n", sth.column_names.size
       sth.column_info.each_with_index do |info, i|
           printf "--- カラム %d (%s) ---\n", i, info.name
           printf "精度:     %s\n", info.precision
           printf "スケール: %s\n", info.scale
       end
   end
   sth.finish

注意事項: 古いバージョンのこの文書では、SELECT文の結果の行数をsth.rowsで得ることができると述べていましたが、これはサポートされていません。(現在のところ MySQL ドライバではたまたま動きますが、この挙動は信頼しないでください。)

コードブロックつきのメソッド

ハンドルを生成するメソッドのうちいくつかはコードブロック付きで呼ぶことができます。ブロック付きで実行した時、ハンドルはコードブロックのパラメータとして渡され、ブロックの実行が終了したら自動的にハンドルが解放されます。

DBI.connectはデータベースハンドルを生成し、必要ならばブロックの最後でデータベースハンドルに対してdisconnectを呼びます。
dbh.prepareは文ハンドルを生成し、ブロックの最後で文ハンドルに対してfinishを呼びます。ブロック内ではSQL文を実行するのに executeを呼んでください。
dbh.executeはブロック内でexecuteを呼ぶ必要がないこと以外はdbh.prepareと同じです。文ハンドルは自動的に実行されます。

これらのハンドルを生成するメソッドそれぞれに対してコードブロックを使った例です。

   # connectはコードブロックをとり、データベースハンドルをブロックに渡します。
   # ブロックの最後では自動的にハンドルを切断します。

   DBI.connect("dbi:Mysql:test:localhost", "testuser", "testpass") do |dbh|

       # prepareはコードブロックをとり、文ハンドルをブロックに渡します。
       # ブロックの最後では自動的にfinishを呼びます。

       dbh.prepare("SHOW DATABASES") do |sth|
           sth.execute
           puts "Databases: " + sth.fetch_all.join(", ")
       end

       # executeはコードブロックをとり、文ハンドルをブロックに渡します。
       # ブロックの最後では自動的にfinishを呼びます。

       dbh.execute("SHOW DATABASES") do |sth|
           puts "Databases: " + sth.fetch_all.join(", ")
       end
   end

他にコードブロックを取るtransactionメソッドがあります。使い方は「トランザクションサポート」で説明されます。

サーバへの接続の補足

以前、例に出したsimple.rbスクリプトはサーバへ接続するのに以下のようにDBIのconnectメソッドを用いています。

   dbh = DBI.connect("dbi:Mysql:test:localhost", "testuser", "testpass")

connectの第一引数はデータソース名(DSN, data source name)で、作成しようとする接続の種類を区別します。残りの２つの引数はMySQLアカウントのユーザ名とパスワードです。

DSN は以下の書式ならどれでも受け付けます。

   dbi:driver_name
   dbi:driver_name:db_name:host_name
   dbi:driver_name:key=val;key=val...

DSNは常にdbiもしくはDBIで始まります。(すべて大文字かすべて小文字かのどちらかです。両者の混在は受け付けません。) 続けて、ドライバ名となります。MySQLの場合はドライバ名はMysqlです。正確に先頭のみを大文字にして用いたほうが良いでしょう。(DBI仕様書にはドライバ名は大文字小文字どちらでも良いと指示されてますが、最新の 0.0.18 でもそれが常に真とはかぎりません。) 他のドライバを使用する場合は、適切なドライバ名を使う必要があります。

dbi(もしくはDBI)とドライバ名は常にDSNに与える必要があります。ドライバ名に続けて何も指定されてないときは、ドライバは(おそらく)デフォルトのデータベースとホスト名を使って接続しようとします。 MySQLドライバの場合はデータベース名を指定する必要があるので、DBIを使ったMySQLプログラミングでは第一の書式は使えません。他の書式を使ってください。第二の書式は２つの値を要求します。コロンで区切られたデータベース名とホスト名です。第三の書式はセミコロンで区切られた param=valueの形式でパラメータの指定を行います。次のDSNはすべて同じ意味をもちます。

   dbi:Mysql:test:localhost
   dbi:Mysql:host=localhost;database=test
   dbi:Mysql:database=test;host=localhost

param=valueの形式を使ったDSNの構文は最も柔軟です。というのも、パラメータを任意の順番で指定できるからです。また、ドライバ固有のパラメータを指定できる可能性もあります。ドライバは受け付けることのできる接続パラメータを拡張することができるからです。MySQLの場合は、hostと databaseの他の追加のパラメータはport、 socket、flagです。(これらのパラメータは、 DBD::Mysqlの下にある Ruby MySQL モジュールの real_connectメソッドの対応するパラメータに渡されます。)

エラー処理とデバッグ

DBIメソッドが失敗するとDBIは例外を上げます。DBIメソッドはどんな例外でも上げる可能性はありますが、データベースに関する操作に対しては、それに関係する例外クラス、DatabaseErrorがあります。このクラスの例外オブジェクトにはerr、errstr、stateという３つの属性があります。DBIドキュメントはこれらの属性の意味を特定してはいませんが、それぞれエラー番号、説明的なエラー文字列、そしてある種の「標準」エラーコードをあらわしているように見えます。MySQLドライバは現時点ではエラー文字列のみを提供しています。しかし、エラー番号を同様に戻すようにするドライバへパッチは簡単なことです。両方の値が利用可能と仮定すると、例外が起こったときにこれらの値を得るには次のようにします。

   rescue DBI::DatabaseError => e
       puts "An error occurred"
       puts "Error code: #{e.err}"
       puts "Error message: #{e.errstr}"

実行しようとするスクリプトが何をしているのかデバッグ情報を実行の順序どおりに得るには、トレース可能な状態にしてください。そうするには、まず最初にdbi/traceモジュールを読み込みます。

   require "dbi/trace"

dbi/traceはdbiモジュールによって自動的には読み込まれません。というのも、AspectRモジュールのバージョン0.3.3以降に依存するからです。AspectRはあなたのマシンに存在しないかもしれません。

dbi/traceモジュールはtraceメソッドを提供します。 traceメソッドでトレースのモードと出力先を設定をします。

   trace(mode, destination)

modeは 0(off)、1、 2、3 の値をとります。 destinationはIOオブジェクトでないといけません。デフォルト値はmodeは2で、destinationは STDERRです。

traceはクラスメソッドとして呼び出されると、続いて作成されるすべてのハンドルに対して影響します。または、ドライバ、データベースハンドル、文ハンドルに対して個々にインスタンスメソッドとして呼び出すこともできます。インスタンスメソッドとして呼ばれると、そのオブジェクトに由来するすべてのオブジェクトに対してもトレースの設定が引き継がれます。例えば、データベースハンドルに対してトレースを有効にすると、そこから作成された文ハンドルのトレースの設定は同じになります。

トランザクション・サポート

トランザクションの使用方法はデータベースによって異なりますが、DBIはトランザクションを抽象化して、同じ手順で使える機能を提供します。しかし、抽象化が使えるかどうかは使用しているデータベースエンジンがトランザクションをサポートしているかどうか、さらには使用するドライバがDBIレベルの抽象化を実装しているかどうかに依存します。MySQLドライバの場合は、この抽象化は DBI 0.0.19 より前では機能していません。したがって、トランザクションを実行するには明示的にSQL文を使って自動コミットレベル、コミット、ロールバックを制御しないといけません。例えば以下のようにです。

   dbh.do("SET AUTOCOMMIT=0")
   dbh.do("BEGIN")
   ... statements that make up the transaction ...
   dbh.do("COMMIT")

DBI 0.0.19 以降では、MySQL でトランザクションの抽象化を利用できます。抽象化の側面のひとつに、自動コミットのレベルをデータベースハンドルの AutoCommit属性の指定で設定できることにあります。

   dbh['AutoCommit'] = true
   dbh['AutoCommit'] = false

自動コミットが無効な間は(falseを設定)、トランザクションは２つの方法で制御できます。次の例でその２つのアプローチを説明します。例としてaccountテーブルを用い、資金をひとりの人から別の人にわたします。

最初の例では、DBIのcommitメソッドとrollbackメソッドを使用してトランザクションを明示的にコミットまたはロールバックします。

   dbh['AutoCommit'] = false
   begin
       dbh.do("UPDATE account SET balance = balance - 50
               WHERE name = 'bill'")
       dbh.do("UPDATE account SET balance = balance + 50
               WHERE name = 'bob'")
       dbh.commit
   rescue
       puts "transaction failed"
       dbh.rollback
   end

二番目のアプローチではtransactionメソッドを使用します。トランザクションとしてなりたつSQL文を含むコードブロックを持つのは同様です。 transactionメソッドはブロックを実行して、ブロックの実行が成功か失敗かによって自動的にcommitまたはrollbackを呼び出します。
```
   dbh['AutoCommit'] = false
   dbh.transaction do |dbh|
       dbh.do("UPDATE account SET balance = balance - 50
               WHERE name = 'bill'")
       dbh.do("UPDATE account SET balance = balance + 50
               WHERE name = 'bob'")
   end
```

ドライバ固有の機能を呼び出す。

DBIはデータベースに依存する特別な機能を利用するためのfunc メソッドを提供してます。例えば MySQL の C API には、使用中のコネクションでの最新のAUTO_INCREMENTの値を戻すmysql_insert_id()関数があります。Ruby MySQL モジュールはデータベースハンドルのメソッドinsert_id を経由してこの関数を呼び出します。また、DBD::Mysql は DBI の funcメカニズムを経由してinsert_idにアクセスします。

funcの第一引数にはデータベース固有のメソッドの名前を指定します。残りの引数には必要ならばデータベース固有のメソッドが必要とする値をわたします。insert_idメソッドは追加の引数を必要とはしません。したがってAUTO_INCREMENTの最新の値を得るには次のようにします。

   dbh.do("INSERT INTO people (name,height) VALUES('Mike',70.5)")
   id = dbh.func(:insert_id)
   puts "ID for new record is: " + id.to_s

DBD::Mysqlによりサポートされるその他のドライバ固有のメソッドは以下のとおりです。

   dbh.func(:createdb, db_name) 新しいデータベースを作成する。
   dbh.func(:dropdb, db_name)   データベースを削除する。
   dbh.func(:reload)            リロード操作を実行する。
   dbh.func(:shutdown)          サーバをシャットダウンする。

あなたの使用しているMySQLクライアントライブラリのバージョンが MySQL 4 以上の場合、createdbとdropdbが使用できないことに注意してください。これらのメソッドは MySQL 4 より Ruby MySQL モジュールで使用してはいけない関数(deprecated functions)となっています。

同じことを実現するのにドライバ固有の機能を使用した場合と通常のSQLを発行して実現する方法の２つがある場合、ドライバ固有の機能を使用したほうが効率的である場合があります。例えば、 SELECT LAST_INSERT_ID() を発行した結果は DBD::Mysqlのinsert_id関数の戻り値でも得ることができます。両者ほほとんどの場合同じ結果を戻します。しかしinsert_id 関数のほうがより効率的です。というのもinsert_idは、問い合わせを発行することなしにクライアント側に保持された値を戻すからです。効率上の利点を追及するには、注意深く関数呼び出しを行う必要があります。 insert_idの値はそれぞれの問い合せの実行毎にリセットされます。そのため、AUTO_INCREMENT値を生成する問い合わせを発行した後、他の問い合わせを発行する前にアクセスしないといけません。対照的にLAST_INSERT_ID()の値はサーバ側にもっと長い時間保持されます。AUTO_INCREMENT値を生成する問い合わせが発行されない限りリセットされることはありません。

その他の便利な機能

DBI::Utilsモジュールには興味深いメソッドがいくつかあります。

DBI::Utils::measure はブロックをとり、ブロック内でどれぐらい実行時間がかかったかを計測します。このメソッドを利用すると以下のように問合せを発行したときの経過時間を測定できます。
```
   elapsed = DBI::Utils::measure do
       dbh.do(query)
   end
   puts "Query: " + query
   puts "Elapsed time: " + elapsed.to_s
```

DBI::Utils::TableFormatterモジュールには、結果セットの内容を表示するasciiメソッドがあります。第一引数はカラム名の配列で、第二引数は行オブジェクトの配列です。peopleテーブルの中身を表示するには以下のようにしてください。

   sth = dbh.execute("SELECT * FROM people")
   rows = sth.fetch_all
   col_names = sth.column_names
   sth.finish
   DBI::Utils::TableFormatter.ascii(col_names, rows)

結果の出力は以下のようになります。

   +----+---------+--------+
   | id | name    | height |
   +----+---------+--------+
   | 1  | Wanda   | 62.5   |
   | 2  | Robert  | 75.0   |
   | 3  | Phillip | 71.5   |
   | 4  | Sarah   | 68.0   |
   +----+---------+--------+

DBI::Utils::XMLFormatterモジュールには結果セットの個々の行を XMLで表示するためのrowメソッドと、結果セット全体をXMLで表示するためのtableメソッドがあります。このモジュールを使用すると、問合せの結果から XML 出力を簡単に作成することができます。以下は tableメソッドの例です。

   DBI::Utils::XMLFormatter.table(dbh.select_all("SELECT * FROM people"))