快捷導(dǎo)航

python用sqlacodegen根據(jù)已有數(shù)據(jù)庫(表)結(jié)構(gòu)生成對應(yīng)SQLAlchemy模型

更新時間：2021年06月15日 10:39:46 作者：一擼程猿

本文介紹了如何使用sqlacodegen獲取數(shù)據(jù)庫所有表的模型類，然后使用ORM技術(shù)進(jìn)行CRUD操作，有此需求的朋友可以了解下本文

今天介紹一個后臺開發(fā)神器，很適合當(dāng)我們數(shù)據(jù)庫中已存在了這些表，然后你想得到它們的model類使用ORM技術(shù)進(jìn)行CRUD操作(或者我根本就不知道怎么寫modle類的時候);
手寫100張表的model類？
這是。。。。。。。。。是不可能的，這輩子都不可能的。
因為我們有sqlacodegen神器，一行命令獲取數(shù)據(jù)庫所有表的模型類。

應(yīng)用場景

1、后臺開發(fā)中，需要經(jīng)常對數(shù)據(jù)庫進(jìn)行CRUD操作；

2、這個過程中，我們就經(jīng)常借助ORM技術(shù)進(jìn)行便利的CURD，比如成熟的SQLAlchemy；

3、但是，進(jìn)行ORM操作前需要提供和table對應(yīng)的模型類；

4、并且，很多歷史table已經(jīng)存在于數(shù)據(jù)庫中；

5、如果有幾百張table呢？還自己一個個去寫嗎？

6、我相信你心中會有個念頭。。。

福音

還是那句話，Python大法好。這里就介紹一個根據(jù)已有數(shù)據(jù)庫(表)結(jié)構(gòu)生成對應(yīng)SQLAlchemy模型類的神器： sqlacodegen

This is a tool that reads the structure of an existing database and generates the appropriate SQLAlchemy model code, using the declarative style if possible.

安裝方法：

pip install sqlacodegen

快快使用

使用方法也很簡單，只需要在終端(命令行窗口)運(yùn)行一行命令即可, 將會獲取到整個數(shù)據(jù)庫的model：
常用數(shù)據(jù)庫的使用方法：

sqlacodegen postgresql:///some_local_db
sqlacodegen mysql+oursql://user:password@localhost/dbname
sqlacodegen sqlite:///database.db

查看具體參數(shù)可以輸入：

sqlacodegen --help

參數(shù)含義：

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)

目前我在postgresql的默認(rèn)的postgres數(shù)據(jù)庫中有個這樣的表：

create table friends
(
  id   varchar(3) primary key ,
  address  varchar(50) not null ,
  name varchar(10) not null
);

create unique index name_address
on friends (name, address);

為了使用ORM進(jìn)行操作，我需要獲取它的modle類但唯一索引的model類怎么寫呢？我們借助sqlacodegen來自動生成就好了

sqlacodegen postgresql://ridingroad:ridingroad@127.0.0.1:5432/postgres --outfile=models.py  --tables friends

模型類效果

查看輸出到models.py的內(nèi)容

# coding: utf-8
from sqlalchemy import Column, Index, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()
metadata = Base.metadata


class Friend(Base):
    __tablename__ = 'friends'
    __table_args__ = (
        Index('name_address', 'name', 'address', unique=True),
    )

    id = Column(String(3), primary_key=True)
    address = Column(String(50), nullable=False)
    name = Column(String(10), nullable=False)

如果你有很多表，就直接指定數(shù)據(jù)庫唄(這是會生成整個數(shù)據(jù)庫的ORM模型類哦),不具體到每張表就好了，后面就可以愉快的CRUD了，耶

注意事項

Why does it sometimes generate classes and sometimes Tables?

Unless the --noclasses option is used, sqlacodegen tries to generate declarative model classes from each table. There are two circumstances in which a Table is generated instead: 1、the table has no primary key constraint (which is required by SQLAlchemy for every model class) 2、the table is an association table between two other tables

當(dāng)你的表的字段缺少primary key或這張表是有兩個外鍵約束的時候，會生成table而不是模型類了。比如，我那張表是這樣的結(jié)構(gòu)：

create table friends
(
  id   varchar(3) ,
  address  varchar(50) not null ,
  name varchar(10) not null
);

create unique index name_address
  on friends (name, address);

再執(zhí)行同一個命令：

sqlacodegen postgresql://ridingroad:ridingroad@127.0.0.1:5432/postgres --outfile=models.py  --tables friends

獲取到的是Table：

# coding: utf-8
from sqlalchemy import Column, Index, MetaData, String, Table

metadata = MetaData()


t_friends = Table(
    'friends', metadata,
    Column('id', String(3)),
    Column('address', String(50), nullable=False),
    Column('name', String(10), nullable=False),
    Index('name_address', 'name', 'address', unique=True)
)

其實(shí)和模型類差不多嘛，但是還是盡量帶上primary key吧，免得手動修改成模型類

以上就是python用sqlacodegen根據(jù)已有數(shù)據(jù)庫(表)結(jié)構(gòu)生成對應(yīng)SQLAlchemy模型的詳細(xì)內(nèi)容，更多關(guān)于python sqlacodegen的使用的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: