Rails プラグイン : ColumnCommentsの使い方

< postgresでo... | ブログ記事一覧 | Rails プラグイン : Rails ... >

はじめまして。新人エンジニアのtnです。
私のブログではRuby on Railsのプラグインの紹介及び導入のガイドをします。

というわけで、第一回はColumnCommentsを紹介します。

マイグレーション・ファイルにDBテーブル上の各カラムのCOMMENTを書けるようにしてくれます(MySQLのみ対応)。

rails1.2.x系では、ColumnComments1.3をダウンロードしてください。
ダウンロードしたzipは解凍し、出来たフォルダをvendor/plugin配下におきます。

テーブルを新規作成をする場合は、マイグレーションファイルに

def self.up

  create_table "users" do |t|

    t.column :name,:string,:null => false,:comment => "This column is the user's name"

    t.column :email,:string,:null => false,:comment => "This column is the user's e-mail address"

end

end

のように記述してください。ここで指定したコメントがカラムのCOMMENTオプションに表示されます。MySQL上でshow create table usersと実行することで、以下のようにコメントが入力出ていることが確認できます。

| Table | Create Table

| users | CREATE TABLE `users` (

  `id` int(11) NOT NULL auto_increment,

  `name` varchar(255) NOT NULL COMMENT 'This column is the user''s name',

  `email` varchar(255) default NULL COMMENT 'This column is the user''s e-mail address',

  PRIMARY KEY  (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=latin1 |

既に作られているテーブルに対しては、

def self.up

 /div column_comment "users","name","This column is the user's name"

end

または

def self.up

  column_comments({

  :users => {:name => "This column is user's name",:email => "This column is user's e-mail address"},

  :items => {:price => "This column is item's price"}

})

end

と記述することで、コメントのみの追加が出来ます。

また、このプラグインにはAnnotateModelsというプラグインも収録されており、

rake annotate_models

を実行すると、テーブルに関連したモデルのファイル上に、入力したコメントが追加されます。

# Schema as of Tue Dec 25 20:37:51 +0900 2007 (schema version 1)

#  id                                      integer(11)         not null

#  name                                    string(255)         default(), not null

#    This column is the user's name

#  email                                   string(255)

#    This column is the user's e-mail address

class User < ActiveRecord::Base

end

これらのプラグインはMySQLのみ対応ですが、PostgreSQLを使った環境にてAnnotateModelsを使うと、コメント以外のカラム情報のみモデルのファイルに記述してくれます。

Rubyでのwebシステム開発は
実績豊富なKBMJにお任せ下さい

iPhone開発は
KBMJにお任せ下さい

クラウドファイル共有サービス「DUB」

オープンソースECパッケージ
「エレコマ」

KBMJ 谷: KBMJの谷と申します。

このブログではRailsプラグインやらRailsのこの機能をなんとなく使ってみたという報告やらを書いています。わりとニッチなところばかりついている感がありますが、お役に立てば光栄です。

ちなみに、ブログタイトルはDoRuby!初期の命名規則の名残です...。"tnの中身"とはなんなんでしょ...。

■開発環境
OS
・会社ではMac OS X
・自宅では基本的にUbuntu(VirtualBox上)です。
エディタ
・vimにrails.vimとminibufexplorerをのっけてます。