Pythonのsqlacodegenが便利です

SQLAlchemyのモデルクラスをDBから作ってくれる

PythonのORMでSQLAlchemyが好きな私ですが、最近のmigrationツールを使えなくなってきたお年寄りなので、

「テーブルから簡単にクラスを作ってくれるツールってないのか...」

と思いつつ、探していたら、sqlacodegenっていうのを見つけました、これSQLAlchemy用のORMクラスをデータベースから作成してくれるツールでシンプルでいけてる

インストール

まずはインストール、とりあえず適当にgentooのebuildを作っておきましたので、gentoo貴族はlaymanで入れて見てください。そのたのディストリビューションなかたはpipで入れて見てください。

karky7 ~ # layman -s karky7
...
...
karky7 ~ # emerge -pv sqlacodegen
...
Calculating dependencies... done!
[ebuild  N    ~] dev-python/inflect-0.2.5::karky7  PYTHON_TARGETS="python2_7 python3_3" 0 KiB
[ebuild  N    ~] dev-python/sqlacodegen-1.1.6::karky7  PYTHON_TARGETS="python2_7 python3_3 -python3_4" 0 KiB
..
..
karky7 ~ # emerge sqlacodegen

使ってみる

シェルからこんな感じで直接データベースを見にいかせるとモデルを全部吐いてくる

cuomo@karky7 ~ $ sqlacodegen mysql://root@localhost/SAMPLEDB
# coding: utf-8
from sqlalchemy import BigInteger, Column, DateTime, ForeignKey, Text
from sqlalchemy.orm import relationship
from sqlalchemy.ext.declarative import declarative_base


Base = declarative_base()
metadata = Base.metadata


class BlogPost(Base):
    __tablename__ = 'BlogPost'

    id = Column(BigInteger, primary_key=True)
    title = Column(Text, nullable=False)
    authorId = Column(ForeignKey(u'Person.id'), nullable=False, index=True)

    Person = relationship(u'Person')


class Person(Base):
    __tablename__ = 'Person'

    id = Column(BigInteger, primary_key=True)
    name = Column(Text, nullable=False)
    age = Column(BigInteger)
    regdate = Column(DateTime)

その他のオプションはこんな感じ--tables [テーブル名]で関連するテーブルだけ吐いてきたり、いろいろできる。

cuomo@karky7 ~ $ sqlacodegen --help
usage: sqlacodegen [-h] [--version] [--schema SCHEMA] [--tables TABLES]
                   [--noviews] [--noindexes] [--noconstraints] [--nojoined]
                   [--noinflect] [--noclasses] [--outfile OUTFILE]
                   [url]

Generates SQLAlchemy model code from an existing database.

positional arguments:
  url                SQLAlchemy url to the database

optional arguments:
  -h, --help         show this help message and exit
  --version          print the version number and exit
  --schema SCHEMA    load tables from an alternate schema
  --tables TABLES    tables to process (comma-separated, default: all)
  --noviews          ignore views
  --noindexes        ignore indexes
  --noconstraints    ignore constraints
  --nojoined         don't autodetect joined table inheritance
  --noinflect        don't try to convert tables names to singular form
  --noclasses        don't generate classes, only tables
  --outfile OUTFILE  file to write output to (default: stdout)

最近、WAFへバンドルされているマイグレーションツールがいっぱいありますが、ちょっと使うには色々と覚える必要があるのでちょっと面倒くさい。
でもこのツールは、必要最低限でやりたいことがhelpを見るだけでできちゃうのが凄くいい。
SQLALchemy専用ですが、私はSQLAlchemy以外は使わないのでこれでいい、ちょっと注意点なんですが、テーブルのコメントなどにutf-8以外の文字コードを含んでいると、Unicodeエラーになってしまうので、その場合はALTER TABLEなどでコメントを削除するか、utf-8で入れ直すかしてみて下さい。