Ruby で記述された MySQL の Ruby API です。MySQL の C API とほぼ同等の機能があります。MySQL/Ruby と ほぼ互換があります。
現在のところ、MySQL 4.1.x では使用できません(mysqld に --old-passwords オプションをつければ使用できるかも)。
黒田 亮 <akuroda at gmail.com> さんが MySQL 4.1.x でも使用できるパッチを作ってくれました。 そのうち取り込むつもりですが、とりあえず置いておきます。
このプログラムは Ruby ライセンスに従います。
% ruby ./setup.rb % ruby ./test.rb hostname user passwd # ruby ./install.rb
% ruby ./setup.rb
MySQL の UNIX ドメインソケットを調べます。UNIX ドメインがない環境 (Microsoft Windows 等)では必要ありません。また、UNIX ドメインソケット が /tmp/mysql.sock である環境(MySQLをソースからコンパイルした場合等)で も必要ありません。
% ruby ./test.rb hostname user passwd
test.rb に与える hostname, user, passwd は MySQL サーバと、そのサーバ上でデータベースを作成することができるユーザ/パス ワードを指定してください。
# ruby ./install.rb
上記コマンドで Ruby の標準的なライブラリディレクトリ (Config::CONFIG["rubylibdir"])にインストールされます。他のディレクトリ に置きたい場合は手でコピーしてください。
例)
require "mysql" my = Mysql::new("host", "user", "passwd", "db") res = my.query("select * from tbl") res.each do |row| col1 = row[0] col2 = row[1] end
メソッド名は C API の関数から mysql_ 接頭辞を除いたものと同じです。メ ソッドの使用方法も基本的に対応する C API 関数と同様ですので、詳細は MySQL のマニュアルを見てください。
メソッド中でエラーが発生した場合は Mysql::Error 例外が発生します。
特に意味のある値を返さない関数は self を返します。
MySQL を操作するためのクラスです。
Mysql クラスオブジェクトを返します。mysqld には接続しません。
mysqld に接続し、Mysql クラスオブジェクトを返します。flag の定数は C API のものと同じです。
例) Mysql::CLIENT_FOUND_ROWS
insert, update 用に文字列をクォートします。 マルチバイト文字でこれを使用してはいけません。
クライアントバージョン情報の文字列を返します。
未対応
接続のためのオプションを設定します。現在有効なオプションは Mysql::OPT_LOCAL_INFILE のみです。val を省略するか真の値を設定すると、 LOAD DATA LOCAL INFILE クエリが使用できます。
Mysql::real_connect() と同じです。Mysql::init() で生成したオブジェクト をサーバに接続するために使用します。
影響された行数を返します。
接続ユーザを変更します。
未対応
接続を切断します。
データベースを作成します。
データベースを破棄します。
C API mysql_dump_debug_info() と同じ。
エラー番号を返します。
エラーメッセージを返します。
insert, update 用に文字列をクオートします。C API の
mysql_real_escape_string() と同じ。
MySQL/Rubyと異なり、charsetに応じた処理を行わないので、マルチバイト文字でこれを使用してはいけません。
最後に実行されたクエリの項目数を返します。
接続情報を文字列で返します。
接続プロトコルバージョンを数値で返します。
サーバのバージョン情報を文字列で返します。
直前のクエリの情報を文字列で返します。特に情報がなければ nil が返りま す。
最後に生成された AUTO_INCREMENT 項目の値を返します。
id で指定したスレッドを殺します。
データベースの一覧を配列で返します。
テーブル内の項目情報の一覧を示す Mysql::Result クラスオブジェクトを返 します。
サーバ上の現在のスレッドの一覧を示す Mysql::Result クラスオブジェクト を返します。
テーブルの一覧を配列で返します。
サーバが生きているかどうかをチェックします。
クエリを実行します。クエリが結果を返す場合、自動的に store_result() も 実行して、Mysql::Result クラスオブジェクトを返します。 query_with_result に false が設定されていれば、store_result() は実行し ません。結果を返さないクエリの場合は nil を返します。
true に設定すると query() 時に store_result() も実行して、MysqlRes ク ラスオブジェクトを返します。false に設定するとその動作は行われません。 デフォルトは true です。
クエリを実行します。query() と異なり、store_result() は実行しません。
サーバのログやキャッシュ等をフラッシュします。
アクセス権テーブルを再読み込みします。
データベースを選択します。
サーバを停止します。
サーバの状態を文字列で返します。
クエリの結果の Mysql::Result クラスオブジェクトを返します。結果をすべ てメモリに読み込みます。
現在の接続のスレッドIDを返します。
クエリの結果の Mysql::Result クラスオブジェクトを返します。結果は Mysql::Result#fetch_row または Mysql::Result#fetch_hash の度に1レコー ドずつ読み込まれます。
クエリ結果のクラスです。互換のために MysqlRes という別名もあります。
現在の行の位置を offset 番目の行にします。
fetch_row() を繰り返し呼び出し、fetch_row() 毎にブロックを実行します。 ブロック引数は fetch_row() の戻り値です。
fetch_hash() を繰り返し呼び出し、fetch_hash() 毎にブロックを実行します。 ブロック引数は fetch_hash() の戻り値です。
現在の項目の Mysql::Field クラスオブジェクトを返します。次に呼ばれた時 は次の項目を返します。
項目全体を表す Mysql::Field クラスオブジェクトの配列を返します。
n 番目の項目の Mysql::Field クラスオブジェクトを返します。
現在の行の各項目値の長さの配列を返します。
検索結果の1行を返します。次に呼ばれた時は次の行を返します。戻り値は項 目値の配列です。
検索結果の1行を返します。次に呼ばれた時は次の行を返します。戻り値は項 目名をキーとした項目値のハッシュです。with_table が true の場合はキー にテーブル名も付加され、"テーブル名.項目名" という形式のキーになります。
現在の項目位置を offset 番目の項目にします。
現在の項目の位置を返します。
結果テーブル用メモリを解放します。GC::start を呼び出します。
項目数を返します。
検索件数を返します。
現在の行の位置を設定します。data_seek() と同じです。
現在の行の位置を返します。
項目の詳細を表すクラスです。互換のために MysqlField という別名もありま す。
項目名
テーブル名
デフォルト値
項目の型
type に対応する定数は C API のものから FIELD_ 接頭辞を除いたものです。 例) Mysql::Field::TYPE_STRING
項目の長さ
検索結果中の項目値の最大長
フラグ
flag に対応する定数は C API のものと同じです。例) Mysql::Field::BLOB_FLAG
小数部桁数
上記の変数名をキーとするハッシュを返します。例) obj.name == obj.hash['name']
MySQL のエラーを表わすクラスです。MySQL のエラーが発生した場合に例外と して生成されます。互換のために MysqlError という別名もあります。
エラー番号
errno に対応する定数は C API のものと同じです。例) Mysql::Error::CR_UNKNOWN_HOST
エラーメッセージ
とみたまさひろ tommy@tmtm.org http://www.tmtm.org